documented non-doc parameters

This commit is contained in:
Sébastien Loriot 2024-10-17 17:58:19 +02:00
parent 04d70f3613
commit 8df5564081
1 changed files with 15 additions and 12 deletions

View File

@ -1048,11 +1048,13 @@ private:
/*! /*!
\brief Face indices of the volume. \brief Face indices of the volume.
\tparam OutputIterator output iterator accepting Index
\param volume_index \param volume_index
index of the query volume. index of the query volume.
@return \param it
vector of face indices. output iterator where faces of the volume are put
\pre created partition \pre created partition
*/ */
@ -1069,8 +1071,7 @@ private:
/*! /*!
\brief Mapping of a vertex index to its position. \brief Mapping of a vertex index to its position.
@return @return point of the vertex
vector of points.
\pre created partition \pre created partition
*/ */
@ -1093,11 +1094,12 @@ private:
/*! /*!
\brief Vertices of a face. \brief Vertices of a face.
\param volume_index \tparam OutputIterator output iterator accepting `Point_3`
index of the query volume.
@return \param face_index
vector of face indices. index of the query face.
\param it output iterator where points of the face are put
\pre created partition \pre created partition
*/ */
@ -1116,11 +1118,12 @@ private:
/*! /*!
\brief Vertices of a face. \brief Vertices of a face.
\param volume_index \tparam OutputIterator output iterator accepting `EPECK::Point_3`
index of the query volume.
@return \param face_index
vector of face indices. index of the query face.
\param it output iterator where points of the face are put
\pre created partition \pre created partition
*/ */