From 8df5564081f8f70ea622b930acc42e9e8be5cb0e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Loriot?= Date: Thu, 17 Oct 2024 17:58:19 +0200 Subject: [PATCH] documented non-doc parameters --- .../include/CGAL/Kinetic_space_partition_3.h | 27 ++++++++++--------- 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/Kinetic_space_partition/include/CGAL/Kinetic_space_partition_3.h b/Kinetic_space_partition/include/CGAL/Kinetic_space_partition_3.h index 46c345a4c87..cabc3eabbd5 100644 --- a/Kinetic_space_partition/include/CGAL/Kinetic_space_partition_3.h +++ b/Kinetic_space_partition/include/CGAL/Kinetic_space_partition_3.h @@ -1048,11 +1048,13 @@ class Kinetic_space_partition_3 { /*! \brief Face indices of the volume. + \tparam OutputIterator output iterator accepting Index + \param volume_index index of the query volume. - @return - vector of face indices. + \param it + output iterator where faces of the volume are put \pre created partition */ @@ -1069,8 +1071,7 @@ class Kinetic_space_partition_3 { /*! \brief Mapping of a vertex index to its position. - @return - vector of points. + @return point of the vertex \pre created partition */ @@ -1093,11 +1094,12 @@ class Kinetic_space_partition_3 { /*! \brief Vertices of a face. - \param volume_index - index of the query volume. + \tparam OutputIterator output iterator accepting `Point_3` - @return - vector of face indices. + \param face_index + index of the query face. + + \param it output iterator where points of the face are put \pre created partition */ @@ -1116,11 +1118,12 @@ class Kinetic_space_partition_3 { /*! \brief Vertices of a face. - \param volume_index - index of the query volume. + \tparam OutputIterator output iterator accepting `EPECK::Point_3` - @return - vector of face indices. + \param face_index + index of the query face. + + \param it output iterator where points of the face are put \pre created partition */