[cig-commits] [commit] master: manual comment formatting (486c413)
cig_noreply at geodynamics.org
cig_noreply at geodynamics.org
Thu Jan 22 08:16:07 PST 2015
Repository : https://github.com/geodynamics/aspect
On branch : master
Link : https://github.com/geodynamics/aspect/compare/2fcde671ad63cce6d01d453c70d572b875893f2b...59e1a2f9609f8666d604a8513b66c1d5f7b326b8
>---------------------------------------------------------------
commit 486c413aa4477ff275f6169e8889af04c47385f1
Author: Timo Heister <timo.heister at gmail.com>
Date: Thu Jan 22 09:15:10 2015 -0500
manual comment formatting
>---------------------------------------------------------------
486c413aa4477ff275f6169e8889af04c47385f1
include/aspect/particle/generator.h | 4 +-
include/aspect/particle/integrator.h | 8 ++--
include/aspect/particle/output.h | 11 ++++--
include/aspect/particle/particle.h | 11 +++---
include/aspect/particle/world.h | 13 +++---
include/aspect/postprocess/visualization.h | 23 +++++------
.../visualization/artificial_viscosity.h | 23 +++++------
.../postprocess/visualization/dynamic_topography.h | 23 +++++------
.../postprocess/visualization/error_indicator.h | 23 +++++------
.../postprocess/visualization/seismic_anomalies.h | 46 +++++++++++-----------
10 files changed, 98 insertions(+), 87 deletions(-)
diff --git a/include/aspect/particle/generator.h b/include/aspect/particle/generator.h
index 7b44ebf..ca78b7c 100644
--- a/include/aspect/particle/generator.h
+++ b/include/aspect/particle/generator.h
@@ -58,7 +58,7 @@ namespace aspect
* @param [in] total_num_particles Total number of particles to
* generate. The actual number of generated particles may differ,
* for example if the generator reads particles from a file this
- * parameter may be ignored. @return
+ * parameter may be ignored.
*/
virtual
void
@@ -71,7 +71,7 @@ namespace aspect
* Create a generator object.
*
* @param[in] generator_type Name of the type of generator to create
- * @return
+ * @return pointer to the generator. Caller needs to delete this pointer.
*/
template <int dim, class T>
Interface<dim, T> *
diff --git a/include/aspect/particle/integrator.h b/include/aspect/particle/integrator.h
index 4846938..2151812 100644
--- a/include/aspect/particle/integrator.h
+++ b/include/aspect/particle/integrator.h
@@ -98,8 +98,8 @@ namespace aspect
* @param [in] pos The position in the data vector to start reading
* from.
* @param [in] id_num The id number of the particle to read the data
- * for. @return The position in the vector of the next unread
- * double.
+ * for.
+ * @return The position in the vector of the next unread double.
*/
virtual unsigned int read_data(const std::vector<double> &data, const unsigned int &pos, const double &id_num) = 0;
@@ -119,8 +119,8 @@ namespace aspect
/**
* Create an integrator object.
*
- * @param[in] integrator_name Name of the type of integrator. @return
- * Pointer to instantiated generator object
+ * @param[in] integrator_name Name of the type of integrator.
+ * @return Pointer to instantiated generator object
*/
template <int dim, class T>
Interface<dim, T> *
diff --git a/include/aspect/particle/output.h b/include/aspect/particle/output.h
index 83626df..9d20fa0 100644
--- a/include/aspect/particle/output.h
+++ b/include/aspect/particle/output.h
@@ -86,9 +86,10 @@ namespace aspect
* @param [in] current_time Current time of the simulation, given as
* either years or seconds, as selected in the input file. In other
* words, output writers do not need to know the units in which time
- * is described. @return The name of the file that was written, or
- * any other information that describes what output was produced if
- * for example multiple files were created.
+ * is described.
+ * @return The name of the file that was written, or any other
+ * information that describes what output was produced if for
+ * example multiple files were created.
*/
virtual
std::string
@@ -115,7 +116,9 @@ namespace aspect
* @param[in] output_directory Directory into which to put the data
* files
* @param[in] communicator MPI communicator object that describes this
- * simulation @return
+ * simulation
+ * @return a pointer to an output object, needs to be deleted by the
+ * caller.
*/
template <int dim, class T>
Interface<dim, T> *
diff --git a/include/aspect/particle/particle.h b/include/aspect/particle/particle.h
index f609312..3dca409 100644
--- a/include/aspect/particle/particle.h
+++ b/include/aspect/particle/particle.h
@@ -122,7 +122,8 @@ namespace aspect
*
* @param [in] data The vector of double data to read from.
* @param [in] pos The position in the data vector to start reading
- * from. @return The position in the vector of the next unread double.
+ * from.
+ * @return The position in the vector of the next unread double.
*/
virtual unsigned int read_data(const std::vector<double> &data, const unsigned int &pos);
@@ -303,8 +304,8 @@ namespace aspect
/**
* Return a reference to an element of the DataParticle data
*
- * @param [in] ind Index of the data array @return Reference to double
- * value at the requested index
+ * @param [in] ind Index of the data array
+ * @return Reference to double value at the requested index
*/
double &operator[](const unsigned int &ind)
{
@@ -315,8 +316,8 @@ namespace aspect
/**
* Return the value of an element of the DataParticle data
*
- * @param [in] ind Index of the data array @return Value at the
- * requested index
+ * @param [in] ind Index of the data array
+ * @return Value at the requested index
*/
double operator[](const unsigned int &ind) const
{
diff --git a/include/aspect/particle/world.h b/include/aspect/particle/world.h
index b9abd0e..b6352c7 100644
--- a/include/aspect/particle/world.h
+++ b/include/aspect/particle/world.h
@@ -101,9 +101,9 @@ namespace aspect
* searched for. The particle will be marked to indicate whether it is
* in the local subdomain or not.
* @param [in] cur_cell The current cell level and index being
- * investigated as potentially containing the particle. @return The
- * level and index of the cell the particle was determined to be in.
- * If no cell was found this returns (-1, -1).
+ * investigated as potentially containing the particle.
+ * @return The level and index of the cell the particle was determined
+ * to be in. If no cell was found this returns (-1, -1).
*/
LevelInd recursive_find_cell(T &particle,
const LevelInd cur_cell)
@@ -498,9 +498,10 @@ namespace aspect
* particle will be updated to indicate whether it is in the local
* subdomain or not.
* @param [in] cur_cell The current cell (level and index) being
- * checked. @return The level and index of the active cell the
- * particle is in. If no cell was found to contain the particle,
- * return the level/index (-1, -1)
+ * checked.
+ * @return The level and index of the active cell the particle is
+ * in. If no cell was found to contain the particle, return the
+ * level/index (-1, -1)
*/
LevelInd find_cell(T &particle, const LevelInd &cur_cell)
{
diff --git a/include/aspect/postprocess/visualization.h b/include/aspect/postprocess/visualization.h
index e3a9b26..e5b72bf 100644
--- a/include/aspect/postprocess/visualization.h
+++ b/include/aspect/postprocess/visualization.h
@@ -196,17 +196,18 @@ namespace aspect
public:
/**
* The function classes have to implement that want to output
- * cellwise data. @return A pair of values with the following
- * meaning: - The first element provides the name by which this data
- * should be written to the output file. - The second element is a
- * pointer to a vector with one element per active cell on the
- * current processor. Elements corresponding to active cells that
- * are either artificial or ghost cells (in deal.II language, see
- * the deal.II glossary) will be ignored but must nevertheless exist
- * in the returned vector. While implementations of this function
- * must create this vector, ownership is taken over by the caller of
- * this function and the caller will take care of destroying the
- * vector pointed to.
+ * cellwise data.
+ * @return A pair of values with the following meaning: - The first
+ * element provides the name by which this data should be written to
+ * the output file. - The second element is a pointer to a vector
+ * with one element per active cell on the current
+ * processor. Elements corresponding to active cells that are either
+ * artificial or ghost cells (in deal.II language, see the deal.II
+ * glossary) will be ignored but must nevertheless exist in the
+ * returned vector. While implementations of this function must
+ * create this vector, ownership is taken over by the caller of this
+ * function and the caller will take care of destroying the vector
+ * pointed to.
*/
virtual
std::pair<std::string, Vector<float> *>
diff --git a/include/aspect/postprocess/visualization/artificial_viscosity.h b/include/aspect/postprocess/visualization/artificial_viscosity.h
index e2d7207..f211c5c 100644
--- a/include/aspect/postprocess/visualization/artificial_viscosity.h
+++ b/include/aspect/postprocess/visualization/artificial_viscosity.h
@@ -44,17 +44,18 @@ namespace aspect
public:
/**
* The function classes have to implement that want to output
- * cellwise data. @return A pair of values with the following
- * meaning: - The first element provides the name by which this data
- * should be written to the output file. - The second element is a
- * pointer to a vector with one element per active cell on the
- * current processor. Elements corresponding to active cells that
- * are either artificial or ghost cells (in deal.II language, see
- * the deal.II glossary) will be ignored but must nevertheless exist
- * in the returned vector. While implementations of this function
- * must create this vector, ownership is taken over by the caller of
- * this function and the caller will take care of destroying the
- * vector pointed to.
+ * cellwise data.
+ * @return A pair of values with the following meaning: - The first
+ * element provides the name by which this data should be written to
+ * the output file. - The second element is a pointer to a vector
+ * with one element per active cell on the current processor.
+ * Elements corresponding to active cells that are either artificial
+ * or ghost cells (in deal.II language, see the deal.II glossary)
+ * will be ignored but must nevertheless exist in the returned
+ * vector. While implementations of this function must create this
+ * vector, ownership is taken over by the caller of this function
+ * and the caller will take care of destroying the vector pointed
+ * to.
*/
virtual
std::pair<std::string, Vector<float> *>
diff --git a/include/aspect/postprocess/visualization/dynamic_topography.h b/include/aspect/postprocess/visualization/dynamic_topography.h
index 8e163c1..7fc0391 100644
--- a/include/aspect/postprocess/visualization/dynamic_topography.h
+++ b/include/aspect/postprocess/visualization/dynamic_topography.h
@@ -52,17 +52,18 @@ namespace aspect
* Evaluate the solution for the dynamic topography.
*
* The function classes have to implement that want to output
- * cellwise data. @return A pair of values with the following
- * meaning: - The first element provides the name by which this data
- * should be written to the output file. - The second element is a
- * pointer to a vector with one element per active cell on the
- * current processor. Elements corresponding to active cells that
- * are either artificial or ghost cells (in deal.II language, see
- * the deal.II glossary) will be ignored but must nevertheless exist
- * in the returned vector. While implementations of this function
- * must create this vector, ownership is taken over by the caller of
- * this function and the caller will take care of destroying the
- * vector pointed to.
+ * cellwise data.
+ * @return A pair of values with the following meaning: - The first
+ * element provides the name by which this data should be written to
+ * the output file. - The second element is a pointer to a vector
+ * with one element per active cell on the current
+ * processor. Elements corresponding to active cells that are either
+ * artificial or ghost cells (in deal.II language, see the deal.II
+ * glossary) will be ignored but must nevertheless exist in the
+ * returned vector. While implementations of this function must
+ * create this vector, ownership is taken over by the caller of this
+ * function and the caller will take care of destroying the vector
+ * pointed to.
*/
virtual
std::pair<std::string, Vector<float> *>
diff --git a/include/aspect/postprocess/visualization/error_indicator.h b/include/aspect/postprocess/visualization/error_indicator.h
index cefe89a..189190e 100644
--- a/include/aspect/postprocess/visualization/error_indicator.h
+++ b/include/aspect/postprocess/visualization/error_indicator.h
@@ -43,17 +43,18 @@ namespace aspect
public:
/**
* The function classes have to implement that want to output
- * cellwise data. @return A pair of values with the following
- * meaning: - The first element provides the name by which this data
- * should be written to the output file. - The second element is a
- * pointer to a vector with one element per active cell on the
- * current processor. Elements corresponding to active cells that
- * are either artificial or ghost cells (in deal.II language, see
- * the deal.II glossary) will be ignored but must nevertheless exist
- * in the returned vector. While implementations of this function
- * must create this vector, ownership is taken over by the caller of
- * this function and the caller will take care of destroying the
- * vector pointed to.
+ * cellwise data.
+ * @return A pair of values with the following meaning: - The first
+ * element provides the name by which this data should be written to
+ * the output file. - The second element is a pointer to a vector
+ * with one element per active cell on the current
+ * processor. Elements corresponding to active cells that are either
+ * artificial or ghost cells (in deal.II language, see the deal.II
+ * glossary) will be ignored but must nevertheless exist in the
+ * returned vector. While implementations of this function must
+ * create this vector, ownership is taken over by the caller of this
+ * function and the caller will take care of destroying the vector
+ * pointed to.
*/
virtual
std::pair<std::string, Vector<float> *>
diff --git a/include/aspect/postprocess/visualization/seismic_anomalies.h b/include/aspect/postprocess/visualization/seismic_anomalies.h
index e975f0e..ff2f837 100644
--- a/include/aspect/postprocess/visualization/seismic_anomalies.h
+++ b/include/aspect/postprocess/visualization/seismic_anomalies.h
@@ -45,17 +45,18 @@ namespace aspect
public:
/**
* The function classes have to implement that want to output
- * cellwise data. @return A pair of values with the following
- * meaning: - The first element provides the name by which this data
- * should be written to the output file. - The second element is a
- * pointer to a vector with one element per active cell on the
- * current processor. Elements corresponding to active cells that
- * are either artificial or ghost cells (in deal.II language, see
- * the deal.II glossary) will be ignored but must nevertheless exist
- * in the returned vector. While implementations of this function
- * must create this vector, ownership is taken over by the caller of
- * this function and the caller will take care of destroying the
- * vector pointed to.
+ * cellwise data.
+ * @return A pair of values with the following meaning: - The first
+ * element provides the name by which this data should be written to
+ * the output file. - The second element is a pointer to a vector
+ * with one element per active cell on the current processor.
+ * Elements corresponding to active cells that are either artificial
+ * or ghost cells (in deal.II language, see the deal.II glossary)
+ * will be ignored but must nevertheless exist in the returned
+ * vector. While implementations of this function must create this
+ * vector, ownership is taken over by the caller of this function
+ * and the caller will take care of destroying the vector pointed
+ * to.
*/
virtual
std::pair<std::string, Vector<float> *>
@@ -76,17 +77,18 @@ namespace aspect
public:
/**
* The function classes have to implement that want to output
- * cellwise data. @return A pair of values with the following
- * meaning: - The first element provides the name by which this data
- * should be written to the output file. - The second element is a
- * pointer to a vector with one element per active cell on the
- * current processor. Elements corresponding to active cells that
- * are either artificial or ghost cells (in deal.II language, see
- * the deal.II glossary) will be ignored but must nevertheless exist
- * in the returned vector. While implementations of this function
- * must create this vector, ownership is taken over by the caller of
- * this function and the caller will take care of destroying the
- * vector pointed to.
+ * cellwise data.
+ * @return A pair of values with the following meaning: - The first
+ * element provides the name by which this data should be written to
+ * the output file. - The second element is a pointer to a vector
+ * with one element per active cell on the current
+ * processor. Elements corresponding to active cells that are either
+ * artificial or ghost cells (in deal.II language, see the deal.II
+ * glossary) will be ignored but must nevertheless exist in the
+ * returned vector. While implementations of this function must
+ * create this vector, ownership is taken over by the caller of this
+ * function and the caller will take care of destroying the vector
+ * pointed to.
*/
virtual
std::pair<std::string, Vector<float> *>
More information about the CIG-COMMITS
mailing list