Merge pull request #1534 from phcerdan/fix_doxygen_surface

Fix doxygen errors in SurfaceMesh and DigitalConvexity

ChangeLog.md

@@ -7,6 +7,8 @@
 - *Documentation*
  - Fix some small errors : includes, variable names, code example
  (adrien Krähenbühl, [#1525](https:/DGtal-team/DGtal/pull/1525))
+ - Fix doxygen errors in DigitalConvexity, SurfaceMesh
+ (Pablo Hernandez-Cerdan [#1534](https:/DGtal-team/DGtal/pull/1534))
 
 - *General*
  - Only set CMAKE_CXX_STANDARD if not defined already

src/DGtal/geometry/volumes/DigitalConvexity.h

@@ -255,7 +255,7 @@ namespace DGtal
  * of lattice points.
  *
  * @tparam PointIterator any model of forward iterator on Point.
- * @param[inout] out the output stream where information is outputed.
+ * @param[in, out] out the output stream where information is outputed.
  * @param itB the start of the range of n+1 points defining the simplex.
  * @param itE past the end the range of n+1 points defining the simplex.
  */
@@ -267,7 +267,7 @@ namespace DGtal
  * Displays information about simplex formed by the given list \a l
  * of lattice points.
  *
- * @param[inout] out the output stream where information is outputed.
+ * @param[in, out] out the output stream where information is outputed.
  * @param l any list of lattice points.
  */
  static

src/DGtal/shapes/SurfaceMesh.h

@@ -161,12 +161,13 @@ namespace DGtal
  /// @tparam RealPointIterator any forward iterator on RealPoint.
  /// @tparam VerticesIterator any forward iterator on the range of vertices defining a face.
  ///
- /// @param itPos,itPosEnd a range of iterators pointing on the positions of all the
- /// vertices of the mesh.
+ /// @param itPos start of range of iterators pointing on the positions of vertices of the mesh
+ /// @param itPosEnd end of range of iterators pointing on the positions of vertices of the mesh.
  ///
- /// @param itVertices,itVerticesEnd a range of iterators pointing
- /// on the (oriented) faces of the mesh, each face being a range
- /// of vertex indices.
+ /// @param itVertices start of range of iterators pointing on the (oriented)
+ /// faces of the mesh, each face being a range of vertex indices.
+ /// @param itVerticesEnd end of range of iterators pointing on the (oriented)
+ /// faces of the mesh, each face being a range of vertex indices.
  ///
  /// A typical construction usage is
  /// @code
@@ -184,12 +185,13 @@ namespace DGtal
  /// @tparam RealPointIterator any forward iterator on RealPoint.
  /// @tparam VerticesIterator any forward iterator on a range of vertices.
  ///
- /// @param itPos,itPosEnd a range of iterators pointing on the positions of all the
- /// vertices of the mesh.
+ /// @param itPos start of range of iterators pointing on the positions of vertices of the mesh
+ /// @param itPosEnd end of range of iterators pointing on the positions of vertices of the mesh.
  ///
- /// @param itVertices,itVerticesEnd a range of iterators pointing
- /// on the (oriented) faces of the mesh, each face being a range
- /// of vertex indices.
+ /// @param itVertices start of range of iterators pointing on the (oriented)
+ /// faces of the mesh, each face being a range of vertex indices.
+ /// @param itVerticesEnd end of range of iterators pointing on the (oriented)
+ /// faces of the mesh, each face being a range of vertex indices.
  ///
  /// A typical construction usage is
  /// @code