From 754cf35342b40c2f7da4dcff2ad9bb0ed4271d88 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mael=20Rouxel-Labb=C3=A9?= Date: Fri, 7 Feb 2020 16:09:30 +0100 Subject: [PATCH 1/2] Fix graph_has_property not showing up in documentation Consequence of the doc being split between doc/CGAL and include/CGAL... --- BGL/doc/BGL/CGAL/boost/graph/properties.h | 26 ++++++++--- BGL/include/CGAL/boost/graph/properties.h | 56 ++++++----------------- 2 files changed, 33 insertions(+), 49 deletions(-) diff --git a/BGL/doc/BGL/CGAL/boost/graph/properties.h b/BGL/doc/BGL/CGAL/boost/graph/properties.h index cbd4d4f960f..cf6c46860b5 100644 --- a/BGL/doc/BGL/CGAL/boost/graph/properties.h +++ b/BGL/doc/BGL/CGAL/boost/graph/properties.h @@ -4,11 +4,6 @@ namespace boost { /// \ingroup PkgBGLProperties /// @{ -/// The constant `edge_index` is a property tag which identifies the index property of an edge of a \sc{Bgl} -/// Graph. -/// \cgalModels PropertyTag -enum edge_index_t { edge_index}; - /// The constant `vertex_index` is a property tag which identifies the index property of a vertex of a \sc{Bgl} /// Graph. /// \cgalModels PropertyTag @@ -20,13 +15,17 @@ enum vertex_index_t { vertex_index }; /// \cgalModels PropertyTag enum halfedge_index_t { halfedge_index }; +/// The constant `edge_index` is a property tag which identifies the index property of an edge of a \sc{Bgl} +/// Graph. +/// \cgalModels PropertyTag +enum edge_index_t { edge_index }; + /// The constant `face_index` is a property tag which identifies the index property of a face of a `FaceGraph`. /// /// This is a property tag introduced by \cgal. /// \cgalModels PropertyTag enum face_index_t { face_index }; - /// The constant `vertex_point` is a property tag which refers to the geometric embedding property of /// a vertex of a `HalfedgeGraph`. /// @@ -34,12 +33,25 @@ enum face_index_t { face_index }; /// \cgalModels PropertyTag enum vertex_point_t { vertex_point }; - /// @} } // namespace boost namespace CGAL { +/// \ingroup PkgBGLProperties +/// +/// \brief graph_has_property is used to indicate if a model of `HalfedgeGraph` or `FaceGraph` +/// has an internal property associated with the given `PropertyTag`. +/// +/// It inherits from \link Tag_true `CGAL::Tag_true` \endlink if there is a +/// default internal property map for the corresponding property tag and from +/// \link Tag_false `CGAL::Tag_false` \endlink otherwise. +/// +/// \tparam Graph a model of `HalfedgeGraph` or `FaceGraph` +/// \tparam PropertyTag the type of a property tag referring to the property of interest. +/// +template +struct graph_has_property; /// @{ diff --git a/BGL/include/CGAL/boost/graph/properties.h b/BGL/include/CGAL/boost/graph/properties.h index 9a86de3f6b8..327066e694c 100644 --- a/BGL/include/CGAL/boost/graph/properties.h +++ b/BGL/include/CGAL/boost/graph/properties.h @@ -33,63 +33,35 @@ #include #include -namespace CGAL{ -/// \ingroup PkgBGLProperties -/// \brief graph_has_property is used to indicate if -/// a model of `HalfedgeGraph` or `FaceGraph` -/// has an internal property associated with the -/// given `PropertyTag`. -/// -/// It inherits from `CGAL::Tag_true` if there is a -/// default internal property map for the -/// corresponding property tag and from -/// `CGAL::Tag_false` otherwise. -/// -/// \tparam Graph a model of `HalfedgeGraph` or `FaceGraph` -/// \tparam PropertyTag the type of a property tag -/// referring to the property of interest. -/// +namespace CGAL { + template -struct graph_has_property -#ifndef DOXYGEN_RUNNING - : CGAL::Tag_false -#endif -{}; -} -/// Boost Namespace +struct graph_has_property : CGAL::Tag_false { }; + +} // namespace CGAL + namespace boost { -/// \ingroup PkgBGLProperties -/// @{ - -/// A property tag which refers to the geometric embedding property -/// of a vertex of a \ref HalfedgeGraph. enum vertex_point_t { vertex_point }; -enum vertex_external_index_t { vertex_external_index } ; -/// A property tag which refers to the property -/// of a halfedge of being a border halfedge. -enum edge_external_index_t { edge_external_index } ; +// vertex_index_t is defined in boost +enum vertex_external_index_t { vertex_external_index }; -/// A property tag which identifies the *index* property of -/// a halfedge of a \ref HalfedgeGraph. -enum halfedge_index_t { halfedge_index }; -enum halfedge_external_index_t { halfedge_external_index } ; +enum halfedge_index_t { halfedge_index }; +enum halfedge_external_index_t { halfedge_external_index }; + +// edge_index_t is defined in boost +enum edge_external_index_t { edge_external_index }; -/// A property tag which identifies the *index* property of -/// a face of a \ref FaceGraph. enum face_index_t { face_index }; -enum face_external_index_t { face_external_index } ; +enum face_external_index_t { face_external_index }; - struct cgal_no_property { typedef bool type; typedef const bool const_type; }; -/// @} - // Introduce those two tags so we can use BOOST_INSTALL_PROPERTY // macro. This is dangerous because we now rely on implementation // details. From 19d18633ae71d3af9279e1ecb8b51703ac11436d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mael=20Rouxel-Labb=C3=A9?= Date: Fri, 7 Feb 2020 16:10:08 +0100 Subject: [PATCH 2/2] Misc doc fixes --- .../CGAL/Surface_mesh_simplification/edge_collapse.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/edge_collapse.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/edge_collapse.h index 878278b4b69..3c69d755acc 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/edge_collapse.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/edge_collapse.h @@ -18,11 +18,11 @@ the number of edges effectively removed. \cgalNamedParamsBegin \cgalParamBegin{vertex_point_map} the property map with the points associated to the vertices of the mesh. If this parameter is omitted, an internal property map for - `CGAL::vertex_point_t` should be available in `PolygonMesh` + `CGAL::vertex_point_t` should be available in `TriangleMesh`. \cgalParamEnd \cgalParamBegin{halfedge_index_map} the property map containing an index for each halfedge, - initialized 0 to `num_halfedges(graph)` + initialized 0 to `num_halfedges(graph)`. \cgalParamEnd \cgalParamBegin{get_cost} @@ -34,7 +34,7 @@ the number of edges effectively removed. \cgalParamEnd \cgalParamBegin{edge_is_constrained_map} - The property map containing the constrained-or-not status of each edge of `pmesh` + The property map containing the constrained-or-not status of each edge of `pmesh`. \cgalParamEnd \cgalParamBegin{visitor}