From 746e00f81ecdd5b7ee9fb9096ae16e4883920efa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mael=20Rouxel-Labb=C3=A9?= Date: Mon, 30 Nov 2020 18:16:39 +0100 Subject: [PATCH] Fix extra underscore in the documentation of the VPM template parameter This is a residual of the usage of CGAL::Default in the class templates. Fix it by also documenting constructors in a #ifdef DOXYGEN_RUNNING block, like the types. --- .../CGAL/AABB_face_graph_triangle_primitive.h | 26 ++++++++++++------- .../AABB_halfedge_graph_segment_primitive.h | 21 ++++++++++----- 2 files changed, 31 insertions(+), 16 deletions(-) diff --git a/AABB_tree/include/CGAL/AABB_face_graph_triangle_primitive.h b/AABB_tree/include/CGAL/AABB_face_graph_triangle_primitive.h index 6657398435c..6d12a85adef 100644 --- a/AABB_tree/include/CGAL/AABB_face_graph_triangle_primitive.h +++ b/AABB_tree/include/CGAL/AABB_face_graph_triangle_primitive.h @@ -98,7 +98,7 @@ class AABB_face_graph_triangle_primitive } public: - #ifdef DOXYGEN_RUNNING +#ifdef DOXYGEN_RUNNING /// \name Types /// @{ /*! @@ -122,18 +122,32 @@ public: If `OneFaceGraphPerTree` is CGAL::Tag_true, constructs a `Shared_data` object from a reference to the polyhedon `graph`. */ static unspecified_type construct_shared_data( FaceGraph& graph ); - #else +#else typedef typename Base::Id Id; - #endif +#endif typedef typename boost::graph_traits::face_descriptor face_descriptor; // constructors + +#ifdef DOXYGEN_RUNNING /*! + constructs a primitive. + \tparam Iterator an input iterator with `Id` as value type. + + If `VertexPointPMap` is the default of the class, an additional constructor + is available with `vppm` set to `get(vertex_point, graph)`. + */ + template + AABB_face_graph_triangle_primitive(Iterator it, const FaceGraph& graph, VertexPointPMap vppm); + + /*! constructs a primitive. If `VertexPointPMap` is the default of the class, an additional constructor is available with `vppm` set to `get(vertex_point, graph)`. */ + AABB_face_graph_triangle_primitive(face_descriptor fd, const FaceGraph& graph, VertexPointPMap vppm); +#else template AABB_face_graph_triangle_primitive(Iterator it, const FaceGraph& graph, VertexPointPMap_ vppm) : Base( Id_(make_id(*it, graph, OneFaceGraphPerTree())), @@ -141,18 +155,12 @@ public: Point_property_map(const_cast(&graph),vppm) ) {} - /*! - constructs a primitive. - If `VertexPointPMap` is the default of the class, an additional constructor - is available with `vppm` set to `get(vertex_point, graph)`. - */ AABB_face_graph_triangle_primitive(face_descriptor fd, const FaceGraph& graph, VertexPointPMap_ vppm) : Base( Id_(make_id(fd, graph, OneFaceGraphPerTree())), Triangle_property_map(const_cast(&graph),vppm), Point_property_map(const_cast(&graph),vppm) ) {} -#ifndef DOXYGEN_RUNNING template AABB_face_graph_triangle_primitive(Iterator it, const FaceGraph& graph) : Base( Id_(make_id(*it, graph, OneFaceGraphPerTree())), diff --git a/AABB_tree/include/CGAL/AABB_halfedge_graph_segment_primitive.h b/AABB_tree/include/CGAL/AABB_halfedge_graph_segment_primitive.h index 1138376df43..a86ba35caac 100644 --- a/AABB_tree/include/CGAL/AABB_halfedge_graph_segment_primitive.h +++ b/AABB_tree/include/CGAL/AABB_halfedge_graph_segment_primitive.h @@ -140,14 +140,27 @@ public: #endif typedef typename boost::graph_traits::edge_descriptor edge_descriptor; +#ifdef DOXYGEN_RUNNING /*! constructs a primitive. + \tparam Iterator is an input iterator with `Id` as value type. + This \ref AABB_tree/AABB_halfedge_graph_edge_example.cpp "example" gives a way to call this constructor using the insert-by-range method of the class `AABB_tree`. If `VertexPointPMap` is the default of the class, an additional constructor is available with `vppm` set to `boost::get(vertex_point, graph)`. */ + template + AABB_halfedge_graph_segment_primitive(Iterator it, const HalfedgeGraph& graph, VertexPointPMap vppm); + + /*! + constructs a primitive. + If `VertexPointPMap` is the default of the class, an additional constructor + is available with `vppm` set to `boost::get(vertex_point, graph)`. + */ + AABB_halfedge_graph_segment_primitive(edge_descriptor ed, const HalfedgeGraph& graph, VertexPointPMap vppm); +#else template AABB_halfedge_graph_segment_primitive(Iterator it, const HalfedgeGraph& graph, VertexPointPMap_ vppm) : Base( Id_(make_id(*it, graph, OneHalfedgeGraphPerTree())), @@ -155,18 +168,12 @@ public: Point_property_map(const_cast(&graph), vppm) ) {} - /*! - constructs a primitive. - If `VertexPointPMap` is the default of the class, an additional constructor - is available with `vppm` set to `boost::get(vertex_point, graph)`. - */ AABB_halfedge_graph_segment_primitive(edge_descriptor ed, const HalfedgeGraph& graph, VertexPointPMap_ vppm) : Base( Id_(make_id(ed, graph, OneHalfedgeGraphPerTree())), Segment_property_map(const_cast(&graph), vppm), Point_property_map(const_cast(&graph), vppm) ) {} - #ifndef DOXYGEN_RUNNING template AABB_halfedge_graph_segment_primitive(Iterator it, const HalfedgeGraph& graph) : Base( Id_(make_id(*it, graph, OneHalfedgeGraphPerTree())), @@ -177,7 +184,7 @@ public: : Base( Id_(make_id(ed, graph, OneHalfedgeGraphPerTree())), Segment_property_map(const_cast(&graph)), Point_property_map(const_cast(&graph)) ){} - #endif +#endif /// \internal typedef internal::Cstr_shared_data Cstr_shared_data;