From 3062ad3a8538893ef1a74168928fbdee52b23510 Mon Sep 17 00:00:00 2001
From: Dmitri Naumov <github@naumov.de>
Date: Sun, 14 Jul 2019 12:24:04 +0200
Subject: [PATCH] [doc] Update parameter names in comments.
---
Applications/ApplicationsLib/ProjectData.h | 2 +-
Applications/FileIO/Gmsh/GMSHPolygonTree.h | 7 ++++---
Applications/FileIO/TetGenInterface.h | 15 +++++++++------
BaseLib/FileTools.h | 5 -----
GeoLib/GEOObjects.h | 2 +-
MaterialLib/FractureModels/CohesiveZoneModeI.h | 2 +-
MathLib/GeometricBasics.h | 4 ++--
MeshGeoToolsLib/BoundaryElementsSearcher.h | 6 ++++--
.../MeshEditing/Mesh2MeshPropertyInterpolation.h | 11 ++++++-----
MeshLib/MeshEditing/RemoveMeshComponents.h | 5 +++--
.../TimeStepping/Algorithms/FixedTimeStepping.h | 16 ++++++++--------
ProcessLib/LIE/Common/LevelSetFunction.h | 2 +-
12 files changed, 40 insertions(+), 37 deletions(-)
diff --git a/Applications/ApplicationsLib/ProjectData.h b/Applications/ApplicationsLib/ProjectData.h
index c5a040f733a..43f52ba86bf 100644
--- a/Applications/ApplicationsLib/ProjectData.h
+++ b/Applications/ApplicationsLib/ProjectData.h
@@ -56,7 +56,7 @@ public:
/// Constructs project data by parsing provided configuration.
///
- /// \param config_tree Configuration as read from the prj file.
+ /// \param project_config Configuration as read from the prj file.
/// \param project_directory Where to look for files referenced in the
/// \c config_tree.
/// \param output_directory Where to write simulation output files to.
diff --git a/Applications/FileIO/Gmsh/GMSHPolygonTree.h b/Applications/FileIO/Gmsh/GMSHPolygonTree.h
index ad658613bbe..3419045306d 100644
--- a/Applications/FileIO/Gmsh/GMSHPolygonTree.h
+++ b/Applications/FileIO/Gmsh/GMSHPolygonTree.h
@@ -44,9 +44,10 @@ public:
void markSharedSegments();
/**
- * If the station point is inside the polygon, the method inserts the station into
- * the internal vector of stations. This method works recursive!
- * @param pnt the station point
+ * If the station point is inside the polygon, the method inserts the
+ * station into the internal vector of stations. This method works
+ * recursive!
+ * @param station the station point
* @return true if the station is inside the polygon
*/
bool insertStation(GeoLib::Point const* station);
diff --git a/Applications/FileIO/TetGenInterface.h b/Applications/FileIO/TetGenInterface.h
index b9afe4cdd0f..390d9446bb8 100644
--- a/Applications/FileIO/TetGenInterface.h
+++ b/Applications/FileIO/TetGenInterface.h
@@ -104,9 +104,10 @@ private:
/**
* Method reads the nodes from stream and stores them in a node vector.
* For this purpose it uses methods parseNodesFileHeader() and parseNodes().
- * @param input the input stream
+ * @param ins the input stream
* @param nodes output vector of nodes.
- * @return true, if all information is read, false if the method detects an error
+ * @return true, if all information is read, false if the method detects an
+ * error
*/
bool readNodesFromStream(std::ifstream& ins,
std::vector<MeshLib::Node*>& nodes);
@@ -139,13 +140,15 @@ private:
std::size_t dim);
/**
- * Method reads the elements from stream and stores them in an element vector.
- * For this purpose it uses methods parseElementsFileHeader() and parseElements().
- * @param input the input stream
+ * Method reads the elements from stream and stores them in an element
+ * vector. For this purpose it uses methods parseElementsFileHeader() and
+ * parseElements().
+ * @param ins the input stream
* @param elements the elements vector to be filled
* @param materials the vector containing material ids to be filled
* @param nodes the node information needed for creating elements
- * @return true, if all information is read, false if the method detects an error
+ * @return true, if all information is read, false if the method detects an
+ * error
*/
bool readElementsFromStream(std::ifstream& ins,
std::vector<MeshLib::Element*>& elements,
diff --git a/BaseLib/FileTools.h b/BaseLib/FileTools.h
index 6f5e35ba62d..f63ab709e9d 100644
--- a/BaseLib/FileTools.h
+++ b/BaseLib/FileTools.h
@@ -105,11 +105,6 @@ std::vector<T> readBinaryArray(std::string const& filename, std::size_t const n)
return std::vector<T>();
}
-/**
- * \brief truncate a file
- *
- * \param file_path the file name
- */
void truncateFile(std::string const& filename);
/**
diff --git a/GeoLib/GEOObjects.h b/GeoLib/GEOObjects.h
index bb08a17d8d9..0a1ecccbee6 100644
--- a/GeoLib/GEOObjects.h
+++ b/GeoLib/GEOObjects.h
@@ -83,7 +83,7 @@ public:
* Adds a vector of points with the given name to GEOObjects.
* @param points vector of pointers to points
* @param name the project name
- * @param pnt_names vector of the names corresponding to the points
+ * @param pnt_id_name_map names corresponding to the points
* @param eps relative tolerance value for testing of point uniqueness
*/
void addPointVec(std::unique_ptr<std::vector<Point*>> points,
diff --git a/MaterialLib/FractureModels/CohesiveZoneModeI.h b/MaterialLib/FractureModels/CohesiveZoneModeI.h
index ce3cb509b3a..4045415f50f 100644
--- a/MaterialLib/FractureModels/CohesiveZoneModeI.h
+++ b/MaterialLib/FractureModels/CohesiveZoneModeI.h
@@ -156,7 +156,7 @@ public:
* @param w fracture displacement at current time step
* @param sigma_prev stress at previous time step
* @param sigma stress at current time step
- * @param Kep tangent matrix for stress and fracture displacements
+ * @param C tangent matrix for stress and fracture displacements
* @param material_state_variables material state variables
*/
void computeConstitutiveRelation(
diff --git a/MathLib/GeometricBasics.h b/MathLib/GeometricBasics.h
index f6387486b1f..184579a635b 100644
--- a/MathLib/GeometricBasics.h
+++ b/MathLib/GeometricBasics.h
@@ -107,12 +107,12 @@ bool isPointInTriangle(
MathLib::TriangleTest algorithm = MathLib::GAUSS);
/**
- * Tests if the given point p is within the triangle, defined by its edge nodes
+ * Tests if the given point q is within the triangle, defined by its edge nodes
* a, b and c.
* Using two eps-values it is possible to test an 'epsilon' neighbourhood around
* the triangle
* as well as an 'epsilon' outside the triangles plane.
- * @param p test point
+ * @param q test point
* @param a edge node of triangle
* @param b edge node of triangle
* @param c edge node of triangle
diff --git a/MeshGeoToolsLib/BoundaryElementsSearcher.h b/MeshGeoToolsLib/BoundaryElementsSearcher.h
index bd901328341..a84a606a7ba 100644
--- a/MeshGeoToolsLib/BoundaryElementsSearcher.h
+++ b/MeshGeoToolsLib/BoundaryElementsSearcher.h
@@ -71,7 +71,8 @@ public:
/**
* generate boundary elements on the given polyline.
- * @param ply the GeoLib::Polyline the nearest mesh nodes are searched for
+ * @param polyline the GeoLib::Polyline the nearest mesh nodes are searched
+ * for
* @return a vector of boundary element objects
*/
std::vector<MeshLib::Element*> const& getBoundaryElementsAlongPolyline(
@@ -79,7 +80,8 @@ public:
/**
* generate boundary elements on the given surface.
- * @param sfc the GeoLib::Surface the nearest mesh nodes are searched for
+ * @param surface the GeoLib::Surface the nearest mesh nodes are searched
+ * for
* @return a vector of boundary element objects
*/
std::vector<MeshLib::Element*> const& getBoundaryElementsOnSurface(
diff --git a/MeshLib/MeshEditing/Mesh2MeshPropertyInterpolation.h b/MeshLib/MeshEditing/Mesh2MeshPropertyInterpolation.h
index 88f29513e61..4a96fa267f9 100644
--- a/MeshLib/MeshEditing/Mesh2MeshPropertyInterpolation.h
+++ b/MeshLib/MeshEditing/Mesh2MeshPropertyInterpolation.h
@@ -31,8 +31,7 @@ class Mesh2MeshPropertyInterpolation final
public:
/**
* Constructor taking the source or input mesh and properties.
- * @param source_mesh the mesh the given property information is
- * assigned to.
+ * @param src_mesh the mesh the given property information is assigned to.
* @param property_name is the name of a PropertyVector in the \c
* source_mesh
*/
@@ -58,9 +57,11 @@ private:
MeshLib::PropertyVector<double>& dest_properties) const;
/**
- * Method interpolates the element wise given properties to the nodes of the element
- * @param interpolated_node_properties the vector must have the same number of entries as
- * the source mesh has number of nodes, the content of the particular entries will be overwritten
+ * Method interpolates the element wise given properties to the nodes of the
+ * element
+ * @param interpolated_properties the vector must have the same number of
+ * entries as the source mesh has number of nodes, the content of the
+ * particular entries will be overwritten
*/
void interpolateElementPropertiesToNodeProperties(
std::vector<double>& interpolated_properties) const;
diff --git a/MeshLib/MeshEditing/RemoveMeshComponents.h b/MeshLib/MeshEditing/RemoveMeshComponents.h
index b41d389f54c..082d23b3861 100644
--- a/MeshLib/MeshEditing/RemoveMeshComponents.h
+++ b/MeshLib/MeshEditing/RemoveMeshComponents.h
@@ -28,9 +28,10 @@ MeshLib::Mesh* removeElements(const MeshLib::Mesh& mesh,
const std::vector<std::size_t> &removed_element_ids, const std::string &new_mesh_name);
/**
- * Removes the mesh nodes (and connected elements) given in the nodes-list from the mesh.
+ * Removes the mesh nodes (and connected elements) given in the nodes-list from
+ * the mesh.
* @param mesh an original mesh whose elements are removed
- * @param removed_node_ids a vector of node indices to be removed
+ * @param del_nodes_idx a vector of node indices to be removed
* @param new_mesh_name a new mesh name
* @return a new mesh object
*/
diff --git a/NumLib/TimeStepping/Algorithms/FixedTimeStepping.h b/NumLib/TimeStepping/Algorithms/FixedTimeStepping.h
index 98c78e00ce2..ff38d1b3bbf 100644
--- a/NumLib/TimeStepping/Algorithms/FixedTimeStepping.h
+++ b/NumLib/TimeStepping/Algorithms/FixedTimeStepping.h
@@ -33,12 +33,12 @@ public:
* A user provides a single time step size \f$\Delta t\f$. Total number of
* time steps is calculated by
* \f[
- * n=\frac{t_{\rm end} - t_{\rm initial}}{\Delta t}
+ * n=\frac{t_{\rm n} - t_0}{\Delta t}
* \f].
*
- * @param t_initial start time
- * @param t_end finish time
- * @param dt uniform time step size
+ * @param t0 start time
+ * @param tn finish time
+ * @param dt uniform time step size
*/
FixedTimeStepping(double t0, double tn, double dt);
@@ -48,12 +48,12 @@ public:
* A user can specify \f$\Delta t\f$ for each time step (i.e. \f$\Delta t_1,
* \Delta t_2, ..., \Delta t_n\f$). Time at \f$m\f$ th step is given as
* \f[
- * t_{m}=\sum_{i=1}^m \Delta t_i + t_{\rm initial}
+ * t_{m}=\sum_{i=1}^m \Delta t_i + t_0
* \f].
*
- * @param t_initial start time
- * @param t_end finish time
- * @param vec_all_dt a vector of all time steps
+ * @param t0 start time
+ * @param tn finish time
+ * @param vec_all_dt a vector of all time steps
*/
FixedTimeStepping(double t0, double tn,
const std::vector<double>& vec_all_dt);
diff --git a/ProcessLib/LIE/Common/LevelSetFunction.h b/ProcessLib/LIE/Common/LevelSetFunction.h
index c1b0c002a9a..617f7a3fc1c 100644
--- a/ProcessLib/LIE/Common/LevelSetFunction.h
+++ b/ProcessLib/LIE/Common/LevelSetFunction.h
@@ -40,7 +40,7 @@ std::vector<double> uGlobalEnrichments(
/// Remarks:
/// * branch/junction intersections of two fractures are supported in 2D
///
-/// @param this_fracID the fracture ID
+/// @param this_frac_id the fracture ID
/// @param frac_props fracture properties
/// @param junction_props junction properties
/// @param fracID_to_local a mapping table from a fracture ID to a local index
--
GitLab