issue CGAL#7395 Improvement of layout of model relations

Corrections after review.
albert-github · Jul 21, 2023 · e4dff1f · e4dff1f
1 parent ad41766
commit e4dff1f
Show file tree

Hide file tree

Showing 11 changed files with 12 additions and 12 deletions.
diff --git a/Generalized_map/doc/Generalized_map/CGAL/Generalized_map.h b/Generalized_map/doc/Generalized_map/CGAL/Generalized_map.h
@@ -8,7 +8,7 @@ The class `Generalized_map` represents a <I>d</I>D generalized map.
 
 Two versions exist: one where darts and non void attributes are stored in memory using `Compact_container`, using `Alloc` as allocator, and use handles as descriptors; a second one where darts and non void attributes are stored in an internal `std::vector` like data-structure, and use indices as descriptors. The choice between the two versions is done through the item class.
 
-\cgalModels{GeneralizedMap}}
+\cgalModels{GeneralizedMap}
 
 \tparam d the dimension of the map.
 

diff --git a/Generator/doc/Generator/CGAL/point_generators_2.h b/Generator/doc/Generator/CGAL/point_generators_2.h
@@ -677,7 +677,7 @@ endpoints are specified upon construction. The points are equally spaced.
 
 \cgalModels{PointGenerator}
 
-\sa `CGAL::points_on_segment_2<Point_2>
+\sa `CGAL::points_on_segment_2<Point_2>`
 \sa `CGAL::Random_points_in_disc_2<Point_2, Creator>`
 \sa `CGAL::Random_points_in_square_2<Point_2, Creator>`
 \sa `CGAL::Random_points_in_triangle_2<Point_2, Creator>`

diff --git a/Number_types/doc/Number_types/CGAL/long_long.h b/Number_types/doc/Number_types/CGAL/long_long.h
@@ -5,4 +5,4 @@
 /// type `long long int` is an `RealEmbeddable` `EuclideanRing`. Due
 /// to overflow `long long int` is considered as not exact.
 ///
-/// \cgalModels{EuclideanRing,cgalModels RealEmbeddable}
+/// \cgalModels{EuclideanRing,RealEmbeddable}
diff --git a/Point_set_3/include/CGAL/Point_set_3.h b/Point_set_3/include/CGAL/Point_set_3.h
@@ -161,7 +161,7 @@ class Point_set_3
 
 #ifdef DOXYGEN_RUNNING
   typedef unspecified_type iterator; ///< Iterator type of the point set with value type `Index` is model of `RandomAccessIterator`
-  typedef unspecified_type const_iterator; ///< Constant iterator type of the point set with value type `Index` is model of `RandomA.ccessIterator
+  typedef unspecified_type const_iterator; ///< Constant iterator type of the point set with value type `Index` is model of `RandomA.ccessIterator`
 #else
   typedef typename Index_map::iterator iterator; ///< Iterator type of the point set
   typedef typename Index_map::const_iterator const_iterator; ///< Constant iterator type of the point set

diff --git a/...ne_simplification_2/include/CGAL/Polyline_simplification_2/Hybrid_squared_distance_cost.h b/...ne_simplification_2/include/CGAL/Polyline_simplification_2/Hybrid_squared_distance_cost.h
@@ -27,7 +27,7 @@ namespace Polyline_simplification_2
 /// This class is a cost function which calculates the cost as the square of the distance between the original and simplified polylines,
 /// possibly scaled based on a factor.
 ///
-/// \cgalModels{PolylineSimplificationCostFunction.}
+/// \cgalModels{PolylineSimplificationCostFunction}
 template<class FT>
 class Hybrid_squared_distance_cost
 {

diff --git a/Polyline_simplification_2/include/CGAL/Polyline_simplification_2/Squared_distance_cost.h b/Polyline_simplification_2/include/CGAL/Polyline_simplification_2/Squared_distance_cost.h
@@ -34,7 +34,7 @@ namespace Polyline_simplification_2
 
 /// This class is a cost function which calculates the cost as the square of the distance between the original and simplified polylines.
 ///
-/// \cgalModels{PolylineSimplificationCostFunction.}
+/// \cgalModels{PolylineSimplificationCostFunction}
 class Squared_distance_cost
 {
 

diff --git a/Polyline_simplification_2/include/CGAL/Polyline_simplification_2/Stop_above_cost_threshold.h b/Polyline_simplification_2/include/CGAL/Polyline_simplification_2/Stop_above_cost_threshold.h
@@ -28,7 +28,7 @@ namespace Polyline_simplification_2
 /// This class is a stop predicate returning `true` when the cost for
 /// simplifying a vertex is greater than a certain threshold.
 ///
-/// \cgalModels{PolylineSimplificationStopPredicate.}
+/// \cgalModels{PolylineSimplificationStopPredicate}
 class Stop_above_cost_threshold
 {
 public :

diff --git a/...implification_2/include/CGAL/Polyline_simplification_2/Stop_below_count_ratio_threshold.h b/...implification_2/include/CGAL/Polyline_simplification_2/Stop_below_count_ratio_threshold.h
@@ -27,7 +27,7 @@ namespace Polyline_simplification_2
 /// This class is a stop predicate returning `true` when the percentage
 /// of remaining vertices is smaller than a certain threshold.
 ///
-/// \cgalModels{PolylineSimplificationStopPredicate.}
+/// \cgalModels{PolylineSimplificationStopPredicate}
 class Stop_below_count_ratio_threshold
 {
 public :

diff --git a/...line_simplification_2/include/CGAL/Polyline_simplification_2/Stop_below_count_threshold.h b/...line_simplification_2/include/CGAL/Polyline_simplification_2/Stop_below_count_threshold.h
@@ -27,7 +27,7 @@ namespace Polyline_simplification_2
 /// This class is a stop predicate returning `true` when the number of
 /// vertices is smaller than a certain threshold.
 ///
-/// \cgalModels{PolylineSimplificationStopPredicate.}
+/// \cgalModels{PolylineSimplificationStopPredicate}
 class Stop_below_count_threshold
 {
 public :

diff --git a/Set_movable_separability_2/doc/Set_movable_separability_2/Concepts/CastingTraits_2.h b/Set_movable_separability_2/doc/Set_movable_separability_2/Concepts/CastingTraits_2.h
@@ -8,7 +8,7 @@
   \cgalRefines{DefaultConstructible,PolygonTraits_2}
 
   \cgalHasModelsBegin
-  \cgalHasModelsBare{Any CGAL kernel, e.g., CGAL::Exact_predicates_exact_constructions_kernel.}
+  \cgalHasModelsBare{Any \cgal kernel, e.g., CGAL::Exact_predicates_exact_constructions_kernel.}
   \cgalHasModelsEnd
 
 */

diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_adapter.h b/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_adapter.h
@@ -16,8 +16,8 @@ with `Key` as  key type  and `Base_distance::Point_d` as  value type.
 
 \tparam Base_distance is a model of either `GeneralDistance` or `OrthogonalDistance`.
 
-\cgalModels{GeneralDistance if Base_distance is a model of `GeneralDistance`,
-            OrthogonalDistance if Base_distance is a model of `OrthogonalDistance`}
+\cgalModels{GeneralDistance if `Base_distance` is a model of `GeneralDistance`,
+            OrthogonalDistance if `Base_distance` is a model of `OrthogonalDistance`}
 
 \sa `Search_traits_adapter<Key,PointPropertyMap,BaseTraits>`