From 24e2f35a258abb2f2ab84009cde2b47ff2bd9cc7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mael=20Rouxel-Labb=C3=A9?= Date: Mon, 9 Mar 2020 11:46:32 +0100 Subject: [PATCH] Document tparam of set_triangulation_ids --- BGL/doc/BGL/CGAL/Triangulation_face_base_with_id_2.h | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/BGL/doc/BGL/CGAL/Triangulation_face_base_with_id_2.h b/BGL/doc/BGL/CGAL/Triangulation_face_base_with_id_2.h index 503e24967e3..15827d6758b 100644 --- a/BGL/doc/BGL/CGAL/Triangulation_face_base_with_id_2.h +++ b/BGL/doc/BGL/CGAL/Triangulation_face_base_with_id_2.h @@ -49,6 +49,12 @@ int& id(); /// This function initializes vertex, edge, and face indices of the triangulation `tr` and must /// be called prior to using `tr` as a BGL graph in an algorithm that requires /// vertex, halfedge, edge, or face indices. +/// +/// \tparam Triangulation a 2D triangulation of \cgal, whose combinatorial data structure +/// has been initialized with the vertex and face classes `Triangulation_vertex_base_with_id_2` +/// and `Triangulation_face_base_with_id_2`. +/// +/// \sa the \ref PkgTriangulation2 package template void set_triangulation_ids(Triangulation& tr);