diff --git a/Algebraic_foundations/doc/Algebraic_foundations/CGAL/number_utils.h b/Algebraic_foundations/doc/Algebraic_foundations/CGAL/number_utils.h index e1ec828c7e0..91e9ebdc59f 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/CGAL/number_utils.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/CGAL/number_utils.h @@ -61,8 +61,8 @@ is a model of the `EuclideanRing` concept. \sa `EuclideanRing` \sa `AlgebraicStructureTraits::Div` -\sa `CGAL::mod` -\sa `CGAL::div_mod` +\sa `CGAL::mod()` +\sa `CGAL::div_mod()` */ template< class NT1, class NT2> @@ -96,8 +96,8 @@ is a model of the `EuclideanRing` concept. \sa `EuclideanRing` \sa `AlgebraicStructureTraits::DivMod` -\sa `CGAL::mod` -\sa `CGAL::div` +\sa `CGAL::mod()` +\sa `CGAL::div()` */ template @@ -344,8 +344,8 @@ is a model of the `EuclideanRing` concept. \sa `EuclideanRing` \sa `AlgebraicStructureTraits::DivMod` -\sa `CGAL::div_mod` -\sa `CGAL::div` +\sa `CGAL::div_mod()` +\sa `CGAL::div()` */ template< class NT1, class NT2> diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arrangement_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arrangement_2.h index e256bec5000..782e98e3134 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arrangement_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arrangement_2.h @@ -31,20 +31,20 @@ namespace CGAL { \sa `ArrangementDcel` \sa `Arr_default_dcel` \sa `ArrangementBasicTraits_2` - \sa `CGAL::overlay` - \sa `CGAL::is_valid` + \sa `CGAL::overlay()` + \sa `CGAL::is_valid()` Insertion Functions \sa `PkgArrangement2Insert` - \sa `CGAL::insert_non_intersecting_curve` - \sa `CGAL::insert_non_intersecting_curves` - \sa `CGAL::insert_point` + \sa `CGAL::insert_non_intersecting_curve()` + \sa `CGAL::insert_non_intersecting_curves()` + \sa `CGAL::insert_point()` Removal functions - \sa `CGAL::remove_edge` - \sa `CGAL::remove_vertex` + \sa `CGAL::remove_edge()` + \sa `CGAL::remove_vertex()` Input/output functions diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Boolean_set_operations_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Boolean_set_operations_2.h index 8b412b347b5..8ee3531a230 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Boolean_set_operations_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Boolean_set_operations_2.h @@ -17,11 +17,11 @@ the `complement function` writes them into an output iterator -\sa `CGAL::do_intersect` -\sa `CGAL::intersection` -\sa `CGAL::join` -\sa `CGAL::difference` -\sa `CGAL::symmetric_difference` +\sa `CGAL::do_intersect()` +\sa `CGAL::intersection()` +\sa `CGAL::join()` +\sa `CGAL::difference()` +\sa `CGAL::symmetric_difference()` */ /// @{ @@ -91,10 +91,10 @@ The types of the paramters of the `difference()` function are any of the followi -\sa `CGAL::do_intersect` -\sa `CGAL::intersection` -\sa `CGAL::join` -\sa `CGAL::symmetric_difference` +\sa `CGAL::do_intersect()` +\sa `CGAL::intersection()` +\sa `CGAL::join()` +\sa `CGAL::symmetric_difference()` */ @@ -211,10 +211,10 @@ The types of the paramters of the `do_intersect()` function are any of the follo -\sa `CGAL::intersection` -\sa `CGAL::join` -\sa `CGAL::difference` -\sa `CGAL::symmetric_difference` +\sa `CGAL::intersection()` +\sa `CGAL::join()` +\sa `CGAL::difference()` +\sa `CGAL::symmetric_difference()` */ @@ -342,10 +342,10 @@ The types of the paramters of the `intersection()` function are any of the follo -\sa `CGAL::do_intersect` -\sa `CGAL::join` -\sa `CGAL::difference` -\sa `CGAL::symmetric_difference` +\sa `CGAL::do_intersect()` +\sa `CGAL::join()` +\sa `CGAL::difference()` +\sa `CGAL::symmetric_difference()` */ @@ -499,10 +499,10 @@ The types of the paramters of the `join()` function are any of the following com -\sa `CGAL::do_intersect` -\sa `CGAL::intersection` -\sa `CGAL::difference` -\sa `CGAL::symmetric_difference` +\sa `CGAL::do_intersect()` +\sa `CGAL::intersection()` +\sa `CGAL::difference()` +\sa `CGAL::symmetric_difference()` */ @@ -653,7 +653,7 @@ The types of the paramters of the `oriented_side()` function are any of the foll -\sa `CGAL::do_intersect` +\sa `CGAL::do_intersect()` */ @@ -740,10 +740,10 @@ The types of the paramters of the `symmetric_difference()` function are any of t -\sa `CGAL::do_intersect` -\sa `CGAL::intersection` -\sa `CGAL::join` -\sa `CGAL::difference` +\sa `CGAL::do_intersect()` +\sa `CGAL::intersection()` +\sa `CGAL::join()` +\sa `CGAL::difference()` */ diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_quadrilateral_traits_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_quadrilateral_traits_2.h index 7d37760f4e4..81be39952c1 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_quadrilateral_traits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_quadrilateral_traits_2.h @@ -12,9 +12,9 @@ functions `min_rectangle_2`, `min_parallelogram_2` and \cgalModels `MinQuadrilateralTraits_2` -\sa `CGAL::min_rectangle_2` -\sa `CGAL::min_parallelogram_2` -\sa `CGAL::min_strip_2` +\sa `CGAL::min_rectangle_2()` +\sa `CGAL::min_parallelogram_2()` +\sa `CGAL::min_strip_2()` */ template< typename K > diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/min_quadrilateral_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/min_quadrilateral_2.h index 08c80d79abd..87a4d53136b 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/min_quadrilateral_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/min_quadrilateral_2.h @@ -37,8 +37,8 @@ type from one the \cgal kernels. In this case, a default traits class
  • `OutputIterator` accepts `VT` as value type. -\sa `CGAL::min_rectangle_2` -\sa `CGAL::min_strip_2` +\sa `CGAL::min_rectangle_2()` +\sa `CGAL::min_strip_2()` \sa `MinQuadrilateralTraits_2` \sa `CGAL::Min_quadrilateral_default_traits_2` @@ -107,8 +107,8 @@ is `CGAL::Point_2` for some kernel `K`.
  • `OutputIterator` accepts `VT` as value type. -\sa `CGAL::min_parallelogram_2` -\sa `CGAL::min_strip_2` +\sa `CGAL::min_parallelogram_2()` +\sa `CGAL::min_strip_2()` \sa `MinQuadrilateralTraits_2` \sa `CGAL::Min_quadrilateral_default_traits_2` @@ -175,8 +175,8 @@ is `CGAL::Point_2` for some kernel `K`.
  • `OutputIterator` accepts `Traits::Line_2` as value type. -\sa `CGAL::min_rectangle_2` -\sa `CGAL::min_parallelogram_2` +\sa `CGAL::min_rectangle_2()` +\sa `CGAL::min_parallelogram_2()` \sa `MinQuadrilateralTraits_2` \sa `CGAL::Min_quadrilateral_default_traits_2` diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/rectangular_p_center_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/rectangular_p_center_2.h index bfe28588339..d7be510f2fd 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/rectangular_p_center_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/rectangular_p_center_2.h @@ -12,7 +12,7 @@ using the function `rectangular_p_center_2`. \cgalModels `RectangularPCenterTraits_2` -\sa `CGAL::rectangular_p_center_2` +\sa `CGAL::rectangular_p_center_2()` */ template< typename K > @@ -240,7 +240,7 @@ is a model for `RectangularPCenterTraits_2`. \sa `RectangularPCenterTraits_2` \sa `CGAL::Rectangular_p_center_default_traits_2` -\sa `CGAL::sorted_matrix_search` +\sa `CGAL::sorted_matrix_search()` \cgalHeading{Implementation} diff --git a/Bounding_volumes/doc/Bounding_volumes/Concepts/MinQuadrilateralTraits_2.h b/Bounding_volumes/doc/Bounding_volumes/Concepts/MinQuadrilateralTraits_2.h index 12f954c38e9..6444179aa21 100644 --- a/Bounding_volumes/doc/Bounding_volumes/Concepts/MinQuadrilateralTraits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/Concepts/MinQuadrilateralTraits_2.h @@ -10,9 +10,9 @@ set using the functions `min_rectangle_2`, \cgalHasModel `CGAL::Min_quadrilateral_default_traits_2` -\sa `CGAL::min_rectangle_2` -\sa `CGAL::min_parallelogram_2` -\sa `CGAL::min_strip_2` +\sa `CGAL::min_rectangle_2()` +\sa `CGAL::min_parallelogram_2()` +\sa `CGAL::min_strip_2()` */ diff --git a/Bounding_volumes/doc/Bounding_volumes/Concepts/RectangularPCenterTraits_2.h b/Bounding_volumes/doc/Bounding_volumes/Concepts/RectangularPCenterTraits_2.h index ddf848e5839..31160336bfa 100644 --- a/Bounding_volumes/doc/Bounding_volumes/Concepts/RectangularPCenterTraits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/Concepts/RectangularPCenterTraits_2.h @@ -9,7 +9,7 @@ using the function `CGAL::rectangular_p_center_2`. \cgalHasModel `CGAL::Rectangular_p_center_default_traits_2` -\sa `CGAL::rectangular_p_center_2` +\sa `CGAL::rectangular_p_center_2()` */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Circle_type.h b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Circle_type.h index 7c6b6d4eb95..ac96f07d415 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Circle_type.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Circle_type.h @@ -5,7 +5,7 @@ namespace CGAL { The enum `Circle_type` is used to classify an object of type `Circle_3`, so as to specify its type (normal,polar,bipolar or threaded), as defined in Section \ref sectionSKobjects. - \sa `CGAL::classify` + \sa `CGAL::classify()` */ enum Circle_type {NORMAL, THREADED, POLAR, BIPOLAR}; } /* end namespace CGAL */ diff --git a/Circulator/doc/Circulator/CGAL/circulator.h b/Circulator/doc/Circulator/CGAL/circulator.h index efed1f96c95..95bd92ff847 100644 --- a/Circulator/doc/Circulator/CGAL/circulator.h +++ b/Circulator/doc/Circulator/CGAL/circulator.h @@ -667,8 +667,8 @@ iterators or circulators, a backwards loop macro `CGAL_For_all_backwards(i, j)` exists that decrements `j` until it reaches `i`. -\sa `CGAL::iterator_distance` -\sa `CGAL::is_empty_range` +\sa `CGAL::iterator_distance()` +\sa `CGAL::is_empty_range()` \sa `CGAL::Circulator_tag` \sa `CGAL::Circulator_traits` \sa `CGAL::Assert_circulator_or_iterator` diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_akl_toussaint.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_akl_toussaint.h index d4d7991bc0b..0f0677bca39 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_akl_toussaint.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_akl_toussaint.h @@ -30,12 +30,12 @@ functions that return instances of these types: -\sa `CGAL::ch_bykat` -\sa `CGAL::ch_eddy` -\sa `CGAL::ch_graham_andrew` -\sa `CGAL::ch_jarvis` -\sa `CGAL::ch_melkman` -\sa `CGAL::convex_hull_2` +\sa `CGAL::ch_bykat()` +\sa `CGAL::ch_eddy()` +\sa `CGAL::ch_graham_andrew()` +\sa `CGAL::ch_jarvis()` +\sa `CGAL::ch_melkman()` +\sa `CGAL::convex_hull_2()` \cgalHeading{Implementation} diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_bykat.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_bykat.h index e95f66044fe..10e8bc9833b 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_bykat.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_bykat.h @@ -31,12 +31,12 @@ functions that return instances of these types: -\sa `CGAL::ch_akl_toussaint` -\sa `CGAL::ch_eddy` -\sa `CGAL::ch_graham_andrew` -\sa `CGAL::ch_jarvis` -\sa `CGAL::ch_melkman` -\sa `CGAL::convex_hull_2` +\sa `CGAL::ch_akl_toussaint()` +\sa `CGAL::ch_eddy()` +\sa `CGAL::ch_graham_andrew()` +\sa `CGAL::ch_jarvis()` +\sa `CGAL::ch_melkman()` +\sa `CGAL::convex_hull_2()` \cgalHeading{Implementation} diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_eddy.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_eddy.h index f2e75b80524..10595945d2a 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_eddy.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_eddy.h @@ -31,12 +31,12 @@ functions that return instances of these types: -\sa `CGAL::ch_akl_toussaint` -\sa `CGAL::ch_bykat` -\sa `CGAL::ch_graham_andrew` -\sa `CGAL::ch_jarvis` -\sa `CGAL::ch_melkman` -\sa `CGAL::convex_hull_2` +\sa `CGAL::ch_akl_toussaint()` +\sa `CGAL::ch_bykat()` +\sa `CGAL::ch_graham_andrew()` +\sa `CGAL::ch_jarvis()` +\sa `CGAL::ch_melkman()` +\sa `CGAL::convex_hull_2()` \cgalHeading{Implementation} diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_graham_andrew.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_graham_andrew.h index 102ea88525d..967fde1c0d2 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_graham_andrew.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_graham_andrew.h @@ -31,15 +31,15 @@ functions that return instances of these types: -\sa `CGAL::ch_akl_toussaint` -\sa `CGAL::ch_bykat` -\sa `CGAL::ch_eddy` -\sa `CGAL::ch_graham_andrew_scan` -\sa `CGAL::ch_jarvis` -\sa `CGAL::ch_melkman` -\sa `CGAL::convex_hull_2` -\sa `CGAL::lower_hull_points_2` -\sa `CGAL::upper_hull_points_2` +\sa `CGAL::ch_akl_toussaint()` +\sa `CGAL::ch_bykat()` +\sa `CGAL::ch_eddy()` +\sa `CGAL::ch_graham_andrew_scan()` +\sa `CGAL::ch_jarvis()` +\sa `CGAL::ch_melkman()` +\sa `CGAL::convex_hull_2()` +\sa `CGAL::lower_hull_points_2()` +\sa `CGAL::upper_hull_points_2()` \cgalHeading{Implementation} @@ -86,9 +86,9 @@ functions that return instances of these types: -\sa `CGAL::ch_graham_andrew` -\sa `CGAL::lower_hull_points_2` -\sa `CGAL::upper_hull_points_2` +\sa `CGAL::ch_graham_andrew()` +\sa `CGAL::lower_hull_points_2()` +\sa `CGAL::upper_hull_points_2()` \cgalHeading{Implementation} diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_jarvis.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_jarvis.h index 8449b3af3c3..919495fd2cf 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_jarvis.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_jarvis.h @@ -30,13 +30,13 @@ functions that return instances of these types: -\sa `CGAL::ch_akl_toussaint` -\sa `CGAL::ch_bykat` -\sa `CGAL::ch_eddy` -\sa `CGAL::ch_graham_andrew` -\sa `CGAL::ch_jarvis_march` -\sa `CGAL::ch_melkman` -\sa `CGAL::convex_hull_2` +\sa `CGAL::ch_akl_toussaint()` +\sa `CGAL::ch_bykat()` +\sa `CGAL::ch_eddy()` +\sa `CGAL::ch_graham_andrew()` +\sa `CGAL::ch_jarvis_march()` +\sa `CGAL::ch_melkman()` +\sa `CGAL::convex_hull_2()` \cgalHeading{Implementation} @@ -82,9 +82,9 @@ functions that return instances of these types: -\sa `CGAL::ch_jarvis` -\sa `CGAL::lower_hull_points_2` -\sa `CGAL::upper_hull_points_2` +\sa `CGAL::ch_jarvis()` +\sa `CGAL::lower_hull_points_2()` +\sa `CGAL::upper_hull_points_2()` \cgalHeading{Implementation} diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_melkman.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_melkman.h index 2807838d7d0..36514113fbe 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_melkman.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_melkman.h @@ -29,13 +29,13 @@ functions that return instances of these types: -\sa `CGAL::ch_akl_toussaint` -\sa `CGAL::ch_bykat` -\sa `CGAL::ch_eddy` -\sa `CGAL::ch_graham_andrew` -\sa `CGAL::ch_jarvis` -\sa `CGAL::ch_melkman` -\sa `CGAL::convex_hull_2` +\sa `CGAL::ch_akl_toussaint()` +\sa `CGAL::ch_bykat()` +\sa `CGAL::ch_eddy()` +\sa `CGAL::ch_graham_andrew()` +\sa `CGAL::ch_jarvis()` +\sa `CGAL::ch_melkman()` +\sa `CGAL::convex_hull_2()` \cgalHeading{Implementation} diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_selected_extreme_points_2.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_selected_extreme_points_2.h index b766dd64451..00dcd7afafc 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_selected_extreme_points_2.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_selected_extreme_points_2.h @@ -20,12 +20,12 @@ value type of `ForwardIterator` is defined. the concept `ConvexHullTraits_2` and the corresponding member function that returns an instance of this type. -\sa `CGAL::ch_nswe_point` -\sa `CGAL::ch_n_point` -\sa `CGAL::ch_ns_point` -\sa `CGAL::ch_s_point` -\sa `CGAL::ch_w_point` -\sa `CGAL::ch_we_point` +\sa `CGAL::ch_nswe_point()` +\sa `CGAL::ch_n_point()` +\sa `CGAL::ch_ns_point()` +\sa `CGAL::ch_s_point()` +\sa `CGAL::ch_w_point()` +\sa `CGAL::ch_we_point()` */ @@ -59,12 +59,12 @@ The default traits class `Default_traits` is the kernel in which the type the concept `ConvexHullTraits_2` and the corresponding member function that returns an instance of this type. -\sa `CGAL::ch_e_point` -\sa `CGAL::ch_nswe_point` -\sa `CGAL::ch_ns_point` -\sa `CGAL::ch_s_point` -\sa `CGAL::ch_w_point` -\sa `CGAL::ch_we_point` +\sa `CGAL::ch_e_point()` +\sa `CGAL::ch_nswe_point()` +\sa `CGAL::ch_ns_point()` +\sa `CGAL::ch_s_point()` +\sa `CGAL::ch_w_point()` +\sa `CGAL::ch_we_point()` */ @@ -100,12 +100,12 @@ value type of `ForwardIterator` is defined. the concept `ConvexHullTraits_2` and the corresponding member function that returns an instance of this type. -\sa `CGAL::ch_e_point` -\sa `CGAL::ch_nswe_point` -\sa `CGAL::ch_n_point` -\sa `CGAL::ch_s_point` -\sa `CGAL::ch_w_point` -\sa `CGAL::ch_we_point` +\sa `CGAL::ch_e_point()` +\sa `CGAL::ch_nswe_point()` +\sa `CGAL::ch_n_point()` +\sa `CGAL::ch_s_point()` +\sa `CGAL::ch_w_point()` +\sa `CGAL::ch_we_point()` */ @@ -150,12 +150,12 @@ functions that return instances of these types: The default traits class `Default_traits` is the kernel in which the type `ForwardIterator::value_type` is defined. -\sa `CGAL::ch_e_point` -\sa `CGAL::ch_n_point` -\sa `CGAL::ch_ns_point` -\sa `CGAL::ch_s_point` -\sa `CGAL::ch_w_point` -\sa `CGAL::ch_we_point` +\sa `CGAL::ch_e_point()` +\sa `CGAL::ch_n_point()` +\sa `CGAL::ch_ns_point()` +\sa `CGAL::ch_s_point()` +\sa `CGAL::ch_w_point()` +\sa `CGAL::ch_we_point()` */ @@ -192,12 +192,12 @@ type `ForwardIterator::value_type` is defined. the concept `ConvexHullTraits_2` and the corresponding member function that returns an instance of this type. -\sa `CGAL::ch_e_point` -\sa `CGAL::ch_nswe_point` -\sa `CGAL::ch_n_point` -\sa `CGAL::ch_ns_point` -\sa `CGAL::ch_w_point` -\sa `CGAL::ch_we_point` +\sa `CGAL::ch_e_point()` +\sa `CGAL::ch_nswe_point()` +\sa `CGAL::ch_n_point()` +\sa `CGAL::ch_ns_point()` +\sa `CGAL::ch_w_point()` +\sa `CGAL::ch_we_point()` */ @@ -233,12 +233,12 @@ type `ForwardIterator::value_type` is defined. the concept `ConvexHullTraits_2` and the corresponding member function that returns an instance of this type. -\sa `CGAL::ch_e_point` -\sa `CGAL::ch_nswe_point` -\sa `CGAL::ch_n_point` -\sa `CGAL::ch_ns_point` -\sa `CGAL::ch_s_point` -\sa `CGAL::ch_w_point` +\sa `CGAL::ch_e_point()` +\sa `CGAL::ch_nswe_point()` +\sa `CGAL::ch_n_point()` +\sa `CGAL::ch_ns_point()` +\sa `CGAL::ch_s_point()` +\sa `CGAL::ch_w_point()` */ @@ -273,12 +273,12 @@ function that returns an instance of this type. The default traits class `Default_traits` is the kernel in which the type `ForwardIterator::value_type` is defined. -\sa `CGAL::ch_e_point` -\sa `CGAL::ch_nswe_point` -\sa `CGAL::ch_n_point` -\sa `CGAL::ch_ns_point` -\sa `CGAL::ch_s_point` -\sa `CGAL::ch_we_point` +\sa `CGAL::ch_e_point()` +\sa `CGAL::ch_nswe_point()` +\sa `CGAL::ch_n_point()` +\sa `CGAL::ch_ns_point()` +\sa `CGAL::ch_s_point()` +\sa `CGAL::ch_we_point()` */ diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_2.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_2.h index 99148d7e7a9..95290848121 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_2.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_2.h @@ -35,12 +35,12 @@ functions that return instances of these types: -\sa `CGAL::ch_akl_toussaint` -\sa `CGAL::ch_bykat` -\sa `CGAL::ch_eddy` -\sa `CGAL::ch_graham_andrew` -\sa `CGAL::ch_jarvis` -\sa `CGAL::ch_melkman` +\sa `CGAL::ch_akl_toussaint()` +\sa `CGAL::ch_bykat()` +\sa `CGAL::ch_eddy()` +\sa `CGAL::ch_graham_andrew()` +\sa `CGAL::ch_jarvis()` +\sa `CGAL::ch_melkman()` \cgalHeading{Implementation} @@ -120,9 +120,9 @@ functions that return instances of these types: -\sa `CGAL::ch_graham_andrew` -\sa `CGAL::ch_graham_andrew_scan` -\sa `CGAL::upper_hull_points_2` +\sa `CGAL::ch_graham_andrew()` +\sa `CGAL::ch_graham_andrew_scan()` +\sa `CGAL::upper_hull_points_2()` \cgalHeading{Implementation} @@ -184,9 +184,9 @@ functions that return instances of these types: -\sa `CGAL::ch_graham_andrew` -\sa `CGAL::ch_graham_andrew_scan` -\sa `CGAL::lower_hull_points_2` +\sa `CGAL::ch_graham_andrew()` +\sa `CGAL::ch_graham_andrew_scan()` +\sa `CGAL::lower_hull_points_2()` \cgalHeading{Implementation} diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/convexity_check_2.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/convexity_check_2.h index b660c802309..0d1476a5285 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/convexity_check_2.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/convexity_check_2.h @@ -27,8 +27,8 @@ functions that return instances of these types:
  • `Traits::Left_turn_2`. -\sa `CGAL::is_cw_strongly_convex_2` -\sa `CGAL::is_strongly_convex_3` +\sa `CGAL::is_cw_strongly_convex_2()` +\sa `CGAL::is_strongly_convex_3()` \cgalHeading{Implementation} @@ -76,8 +76,8 @@ functions that return instances of these types:
  • `Traits::Left_turn_2`. -\sa `CGAL::is_ccw_strongly_convex_2` -\sa `CGAL::is_strongly_convex_3` +\sa `CGAL::is_ccw_strongly_convex_2()` +\sa `CGAL::is_strongly_convex_3()` \cgalHeading{Implementation} diff --git a/Convex_hull_3/doc/Convex_hull_3/Concepts/IsStronglyConvexTraits_3.h b/Convex_hull_3/doc/Convex_hull_3/Concepts/IsStronglyConvexTraits_3.h index 5531daa9f57..f3e7f976e74 100644 --- a/Convex_hull_3/doc/Convex_hull_3/Concepts/IsStronglyConvexTraits_3.h +++ b/Convex_hull_3/doc/Convex_hull_3/Concepts/IsStronglyConvexTraits_3.h @@ -10,7 +10,7 @@ by `CGAL::convex_hull_3()`. \cgalHasModel All models of `Kernel` \sa `ConvexHullTraits_3` -\sa `CGAL::is_strongly_convex_3` +\sa `CGAL::is_strongly_convex_3()` */ diff --git a/Generator/doc/Generator/CGAL/point_generators_2.h b/Generator/doc/Generator/CGAL/point_generators_2.h index 3729bde1e4c..58069a0e8ba 100644 --- a/Generator/doc/Generator/CGAL/point_generators_2.h +++ b/Generator/doc/Generator/CGAL/point_generators_2.h @@ -27,10 +27,10 @@ are needed from `rnd` for each point. coordinate values. -\sa `CGAL::points_on_segment_2` -\sa `CGAL::points_on_square_grid_2` -\sa `CGAL::random_selection` -\sa `CGAL::random_selection` +\sa `CGAL::points_on_segment_2()` +\sa `CGAL::points_on_square_grid_2()` +\sa `CGAL::random_selection()` +\sa `CGAL::random_selection()` \sa `std::random_shuffle` */ @@ -52,9 +52,9 @@ the \f$ n\f$ points. -\sa `CGAL::points_on_segment_2` -\sa `CGAL::points_on_square_grid_2` -\sa `CGAL::random_collinear_points_2` +\sa `CGAL::points_on_segment_2()` +\sa `CGAL::points_on_square_grid_2()` +\sa `CGAL::random_collinear_points_2()` */ template @@ -85,11 +85,11 @@ the \f$ n\f$ points. the `value_type` in this case. -\sa `CGAL::perturb_points_2` -\sa `CGAL::points_on_segment_2` -\sa `CGAL::points_on_cube_grid_3` -\sa `CGAL::random_collinear_points_2` -\sa `CGAL::random_selection` +\sa `CGAL::perturb_points_2()` +\sa `CGAL::points_on_segment_2()` +\sa `CGAL::points_on_cube_grid_3()` +\sa `CGAL::random_collinear_points_2()` +\sa `CGAL::random_selection()` \sa `std::random_shuffle` */ @@ -122,10 +122,10 @@ Returns the value of `first2` after inserting the \f$ n\f$ points. `to_double((*first).y())` must result in the respective coordinate values. -\sa `CGAL::perturb_points_2` -\sa `CGAL::points_on_segment_2` -\sa `CGAL::points_on_square_grid_2` -\sa `CGAL::random_selection` +\sa `CGAL::perturb_points_2()` +\sa `CGAL::points_on_segment_2()` +\sa `CGAL::points_on_square_grid_2()` +\sa `CGAL::random_selection()` \sa `std::random_shuffle` */ @@ -146,7 +146,7 @@ distributed in an open disc. The default `Creator` is \cgalModels `InputIterator` \cgalModels `PointGenerator` -\sa `CGAL::cpp11::copy_n` +\sa `CGAL::cpp11::copy_n()` \sa `CGAL::Counting_iterator` \sa `CGAL::Points_on_segment_2` \sa `CGAL::Random_points_in_square_2` @@ -213,7 +213,7 @@ distributed in a half-open square. The default `Creator` is \cgalModels `InputIterator` \cgalModels `PointGenerator` -\sa `CGAL::cpp11::copy_n` +\sa `CGAL::cpp11::copy_n()` \sa `CGAL::Counting_iterator` \sa `CGAL::Points_on_segment_2` \sa `CGAL::Random_points_in_disc_2` @@ -284,7 +284,7 @@ rounding errors. \cgalModels `InputIterator` \cgalModels `PointGenerator` -\sa `CGAL::cpp11::copy_n` +\sa `CGAL::cpp11::copy_n()` \sa `CGAL::Counting_iterator` \sa `CGAL::Points_on_segment_2` \sa `CGAL::Random_points_in_disc_2` @@ -354,7 +354,7 @@ distributed on a segment. The default `Creator` is \cgalModels `InputIterator` \cgalModels `PointGenerator` -\sa `CGAL::cpp11::copy_n` +\sa `CGAL::cpp11::copy_n()` \sa `CGAL::Counting_iterator` \sa `CGAL::Points_on_segment_2` \sa `CGAL::Random_points_in_disc_2` @@ -423,7 +423,7 @@ distributed on the boundary of a square. The default `Creator` is \cgalModels `InputIterator` \cgalModels `PointGenerator` -\sa `CGAL::cpp11::copy_n` +\sa `CGAL::cpp11::copy_n()` \sa `CGAL::Counting_iterator` \sa `CGAL::Points_on_segment_2` \sa `CGAL::Random_points_in_disc_2` @@ -492,7 +492,7 @@ endpoints are specified upon construction. The points are equally spaced. \cgalModels `PointGenerator` -\sa `CGAL::cpp11::copy_n` +\sa `CGAL::cpp11::copy_n()` \sa `CGAL::Counting_iterator` \sa `CGAL::points_on_segment` \sa `CGAL::Random_points_in_disc_2` @@ -500,7 +500,7 @@ endpoints are specified upon construction. The points are equally spaced. \sa `CGAL::Random_points_on_circle_2` \sa `CGAL::Random_points_on_segment_2` \sa `CGAL::Random_points_on_square_2` -\sa `CGAL::random_selection` +\sa `CGAL::random_selection()` \sa `std::random_shuffle` */ diff --git a/Generator/doc/Generator/CGAL/point_generators_3.h b/Generator/doc/Generator/CGAL/point_generators_3.h index ebdb98509e5..980605f2966 100644 --- a/Generator/doc/Generator/CGAL/point_generators_3.h +++ b/Generator/doc/Generator/CGAL/point_generators_3.h @@ -23,9 +23,9 @@ inserting the \f$ n\f$ points. the `value_type` in this case. -\sa `CGAL::points_on_square_grid_2` +\sa `CGAL::points_on_square_grid_2()` -\sa `CGAL::random_selection` +\sa `CGAL::random_selection()` */ template @@ -44,7 +44,7 @@ distributed in a half-open cube. The default `Creator` is \cgalModels `InputIterator` \cgalModels `PointGenerator` -\sa `CGAL::cpp11::copy_n` +\sa `CGAL::cpp11::copy_n()` \sa `CGAL::Counting_iterator` \sa `CGAL::Random_points_in_square_2` \sa `CGAL::Random_points_in_sphere_3` @@ -111,7 +111,7 @@ distributed in an open sphere. The default `Creator` is \cgalModels `InputIterator` \cgalModels `PointGenerator` -\sa `CGAL::cpp11::copy_n` +\sa `CGAL::cpp11::copy_n()` \sa `CGAL::Counting_iterator` \sa `CGAL::Random_points_in_disc_2` \sa `CGAL::Random_points_in_cube_3` @@ -181,7 +181,7 @@ rounding errors. \cgalModels `InputIterator` \cgalModels `PointGenerator` -\sa `CGAL::cpp11::copy_n` +\sa `CGAL::cpp11::copy_n()` \sa `CGAL::Counting_iterator` \sa `CGAL::Random_points_on_circle_2` \sa `CGAL::Random_points_in_cube_3` diff --git a/Generator/doc/Generator/CGAL/point_generators_d.h b/Generator/doc/Generator/CGAL/point_generators_d.h index 4399da5a420..71e32088960 100644 --- a/Generator/doc/Generator/CGAL/point_generators_d.h +++ b/Generator/doc/Generator/CGAL/point_generators_d.h @@ -25,8 +25,8 @@ The dimension of `Creator` should be \f$ dim\f$.
  • The `OutputIterator` must accept values of type `P`. -\sa `CGAL::points_on_square_grid_2` -\sa `CGAL::points_on_cube_grid_3` +\sa `CGAL::points_on_square_grid_2()` +\sa `CGAL::points_on_cube_grid_3()` */ template @@ -43,7 +43,7 @@ distributed in an open ball in any dimension. \cgalModels `InputIterator` \cgalModels `PointGenerator` -\sa `CGAL::cpp11::copy_n` +\sa `CGAL::cpp11::copy_n()` \sa `CGAL::Counting_iterator` \sa `CGAL::Random_points_in_disc_2` \sa `CGAL::Random_points_in_sphere_3` @@ -112,7 +112,7 @@ distributed in an half-open cube. \cgalModels `InputIterator` \cgalModels `PointGenerator` -\sa `CGAL::cpp11::copy_n` +\sa `CGAL::cpp11::copy_n()` \sa `CGAL::Counting_iterator` \sa `CGAL::Random_points_in_square_2` \sa `CGAL::Random_points_in_cube_3` @@ -187,7 +187,7 @@ rounding errors. \cgalModels `InputIterator` \cgalModels `PointGenerator` -\sa `CGAL::cpp11::copy_n` +\sa `CGAL::cpp11::copy_n()` \sa `CGAL::Counting_iterator` \sa `CGAL::Random_points_on_circle_2` \sa `CGAL::Random_points_on_sphere_3` diff --git a/Inscribed_areas/doc/Inscribed_areas/CGAL/Extremal_polygon_traits_2.h b/Inscribed_areas/doc/Inscribed_areas/CGAL/Extremal_polygon_traits_2.h index c9dd68320e1..96fd4b6001c 100644 --- a/Inscribed_areas/doc/Inscribed_areas/CGAL/Extremal_polygon_traits_2.h +++ b/Inscribed_areas/doc/Inscribed_areas/CGAL/Extremal_polygon_traits_2.h @@ -12,9 +12,9 @@ be inscribed into a given convex polygon \f$ P\f$ using the function \cgalModels `ExtremalPolygonTraits_2` -\sa `CGAL::maximum_area_inscribed_k_gon_2` -\sa `CGAL::maximum_perimeter_inscribed_k_gon_2` -\sa `CGAL::extremal_polygon_2` +\sa `CGAL::maximum_area_inscribed_k_gon_2()` +\sa `CGAL::maximum_perimeter_inscribed_k_gon_2()` +\sa `CGAL::extremal_polygon_2()` \sa `CGAL::Extremal_polygon_perimeter_traits_2` \sa `ExtremalPolygonTraits_2` @@ -114,9 +114,9 @@ k\f$-gon \f$ P_k\f$ that can be inscribed into a given convex polygon \cgalModels `ExtremalPolygonTraits_2` -\sa `CGAL::maximum_area_inscribed_k_gon_2` -\sa `CGAL::maximum_perimeter_inscribed_k_gon_2` -\sa `CGAL::extremal_polygon_2` +\sa `CGAL::maximum_area_inscribed_k_gon_2()` +\sa `CGAL::maximum_perimeter_inscribed_k_gon_2()` +\sa `CGAL::extremal_polygon_2()` \sa `CGAL::Extremal_polygon_area_traits_2` \sa `ExtremalPolygonTraits_2` diff --git a/Inscribed_areas/doc/Inscribed_areas/Concepts/ExtremalPolygonTraits_2.h b/Inscribed_areas/doc/Inscribed_areas/Concepts/ExtremalPolygonTraits_2.h index dcd395e4f2e..da12dca8918 100644 --- a/Inscribed_areas/doc/Inscribed_areas/Concepts/ExtremalPolygonTraits_2.h +++ b/Inscribed_areas/doc/Inscribed_areas/Concepts/ExtremalPolygonTraits_2.h @@ -15,9 +15,9 @@ specified, in case that precondition checking is disabled. \cgalHasModel `CGAL::Extremal_polygon_area_traits_2` \cgalHasModel `CGAL::Extremal_polygon_perimeter_traits_2` -\sa `CGAL::maximum_area_inscribed_k_gon_2` -\sa `CGAL::maximum_perimeter_inscribed_k_gon_2` -\sa `CGAL::extremal_polygon_2` +\sa `CGAL::maximum_area_inscribed_k_gon_2()` +\sa `CGAL::maximum_perimeter_inscribed_k_gon_2()` +\sa `CGAL::extremal_polygon_2()` */ diff --git a/Matrix_search/doc/Matrix_search/CGAL/Dynamic_matrix.h b/Matrix_search/doc/Matrix_search/CGAL/Dynamic_matrix.h index 50dda164f9c..83790e04f24 100644 --- a/Matrix_search/doc/Matrix_search/CGAL/Dynamic_matrix.h +++ b/Matrix_search/doc/Matrix_search/CGAL/Dynamic_matrix.h @@ -13,7 +13,7 @@ matrix search. \cgalModels `MonotoneMatrixSearchTraits` \cgalModels `BasicMatrix` -\sa `CGAL::monotone_matrix_search` +\sa `CGAL::monotone_matrix_search()` \sa `MonotoneMatrixSearchTraits` \sa `BasicMatrix` diff --git a/Matrix_search/doc/Matrix_search/Concepts/MonotoneMatrixSearchTraits.h b/Matrix_search/doc/Matrix_search/Concepts/MonotoneMatrixSearchTraits.h index 63b715c9c04..1fdeabeaa75 100644 --- a/Matrix_search/doc/Matrix_search/Concepts/MonotoneMatrixSearchTraits.h +++ b/Matrix_search/doc/Matrix_search/Concepts/MonotoneMatrixSearchTraits.h @@ -23,7 +23,7 @@ matrix classes. \cgalHasModel `CGAL::Dynamic_matrix` -\sa `CGAL::monotone_matrix_search` +\sa `CGAL::monotone_matrix_search()` */ diff --git a/Matrix_search/doc/Matrix_search/Concepts/SortedMatrixSearchTraits.h b/Matrix_search/doc/Matrix_search/Concepts/SortedMatrixSearchTraits.h index 3315692578c..52a9e5e83d9 100644 --- a/Matrix_search/doc/Matrix_search/Concepts/SortedMatrixSearchTraits.h +++ b/Matrix_search/doc/Matrix_search/Concepts/SortedMatrixSearchTraits.h @@ -10,7 +10,7 @@ that fulfills a certain feasibility criterion using the function \cgalHasModel `CGAL::Sorted_matrix_search_traits_adaptor` -\sa `CGAL::sorted_matrix_search` +\sa `CGAL::sorted_matrix_search()` \sa `BasicMatrix` */ diff --git a/Mesh_3/doc/Mesh_3/CGAL/Mesh_cell_criteria_3.h b/Mesh_3/doc/Mesh_3/CGAL/Mesh_cell_criteria_3.h index df871bc1cd5..feb477d710d 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_cell_criteria_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_cell_criteria_3.h @@ -16,7 +16,7 @@ and a sizing field which may be a uniform or variable field. \sa `MeshCriteria_3` \sa `CGAL::Mesh_criteria_3` -\sa `CGAL::make_mesh_3` +\sa `CGAL::make_mesh_3()` */ template< typename Tr > diff --git a/Mesh_3/doc/Mesh_3/CGAL/Polyhedral_mesh_domain_3.h b/Mesh_3/doc/Mesh_3/CGAL/Polyhedral_mesh_domain_3.h index 6de0bde1bcc..b731214108f 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Polyhedral_mesh_domain_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Polyhedral_mesh_domain_3.h @@ -32,7 +32,7 @@ be identical to the type `TriangleAccessor::Triangle_3`. \sa `TriangleAccessor_3` \sa `IntersectionGeometricTraits_3` \sa `CGAL::Triangle_accessor_3,K>` -\sa `CGAL::make_mesh_3`. +\sa `CGAL::make_mesh_3()`. */ template< typename Polyhedron, typename IGT, typename TriangleAccessor > diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshCellBase_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshCellBase_3.h index b0b2805818b..f88b90717e6 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshCellBase_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshCellBase_3.h @@ -31,7 +31,7 @@ of a surface facet, the center of its biggest Delaunay surface ball. \cgalHasModel `CGAL::Mesh_cell_base_3` -\sa `CGAL::make_mesh_3` +\sa `CGAL::make_mesh_3()` \sa `MeshDomain_3` \sa `MeshComplex_3InTriangulation_3` diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshCellCriteria_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshCellCriteria_3.h index 369e85c2cd4..cc3a03c33ba 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshCellCriteria_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshCellCriteria_3.h @@ -14,8 +14,8 @@ handle the refinement criteria for mesh tetrahedra. \sa `MeshEdgeCriteria_3` \sa `MeshFacetCriteria_3` \sa `MeshCriteria_3` -\sa `CGAL::make_mesh_3` -\sa `CGAL::refine_mesh_3` +\sa `CGAL::make_mesh_3()` +\sa `CGAL::refine_mesh_3()` */ diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshComplex_3InTriangulation_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshComplex_3InTriangulation_3.h index c16a7e73dbc..62d7d565dac 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshComplex_3InTriangulation_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshComplex_3InTriangulation_3.h @@ -46,7 +46,7 @@ The data structure encodes the final mesh at the end of the meshing process. \sa `MeshDomain_3` \sa `MeshComplexWithFeatures_3InTriangulation_3` -\sa `CGAL::make_mesh_3` +\sa `CGAL::make_mesh_3()` */ diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshCriteriaWithFeatures_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshCriteriaWithFeatures_3.h index 9dbda88d471..9e859022782 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshCriteriaWithFeatures_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshCriteriaWithFeatures_3.h @@ -20,8 +20,8 @@ that describes the requirements, in terms of sizing, for the discretization of t \sa `MeshEdgeCriteria_3` \sa `MeshFacetCriteria_3` \sa `MeshCellCriteria_3` -\sa `CGAL::make_mesh_3` -\sa `CGAL::refine_mesh_3` +\sa `CGAL::make_mesh_3()` +\sa `CGAL::refine_mesh_3()` */ diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshCriteria_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshCriteria_3.h index 1e3fe9a2454..deb3fffc40b 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshCriteria_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshCriteria_3.h @@ -16,8 +16,8 @@ The concept `MeshCriteria_3` encapsulates these concepts. \sa `MeshFacetCriteria_3` \sa `MeshCellCriteria_3` -\sa `CGAL::make_mesh_3` -\sa `CGAL::refine_mesh_3` +\sa `CGAL::make_mesh_3()` +\sa `CGAL::refine_mesh_3()` \sa `MeshCriteriaWithFeatures_3` */ diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshDomain_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshDomain_3.h index c8af7f2f16b..e63f064f941 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshDomain_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshDomain_3.h @@ -35,8 +35,8 @@ and strictly outside the domain (resp. the subdomain). \sa `MeshVertexBase_3` \sa `MeshCellBase_3` -\sa `CGAL::make_mesh_3` -\sa `CGAL::refine_mesh_3` +\sa `CGAL::make_mesh_3()` +\sa `CGAL::refine_mesh_3()` */ diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshFacetCriteria_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshFacetCriteria_3.h index b212976d7f8..8b771075d58 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshFacetCriteria_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshFacetCriteria_3.h @@ -14,8 +14,8 @@ handle the refinement criteria for surface facets. \sa `MeshCellCriteria_3` \sa `MeshEdgeCriteria_3` \sa `MeshCriteria_3` -\sa `CGAL::make_mesh_3` -\sa `CGAL::refine_mesh_3` +\sa `CGAL::make_mesh_3()` +\sa `CGAL::refine_mesh_3()` */ diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshVertexBase_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshVertexBase_3.h index 3553a4c537c..bb0f56109a8 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshVertexBase_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshVertexBase_3.h @@ -20,8 +20,8 @@ and to an index characteristic of this face. \cgalHasModel `CGAL::Mesh_vertex_base_3` -\sa `CGAL::make_mesh_3` -\sa `CGAL::refine_mesh_3` +\sa `CGAL::make_mesh_3()` +\sa `CGAL::refine_mesh_3()` \sa `MeshDomain_3` */ diff --git a/Mesh_3/doc/Mesh_3/Concepts/TriangleAccessor_3.h b/Mesh_3/doc/Mesh_3/Concepts/TriangleAccessor_3.h index 9ebfbdf202f..0f76b59a7e1 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/TriangleAccessor_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/TriangleAccessor_3.h @@ -8,7 +8,7 @@ surface, intersection free and without boundaries. \cgalHasModel `CGAL::Triangle_accessor_3,K>` \sa `CGAL::Polyhedral_mesh_domain_3` -\sa `CGAL::make_mesh_3` +\sa `CGAL::make_mesh_3()` */ diff --git a/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_convex_decomposition_2.h b/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_convex_decomposition_2.h index 06c69515a78..58aa684fc7e 100644 --- a/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_convex_decomposition_2.h +++ b/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_convex_decomposition_2.h @@ -18,7 +18,7 @@ It is by default `std::vector`. \cgalModels `PolygonConvexDecomposition_2` -\sa `CGAL::greene_approx_convex_partition_2` +\sa `CGAL::greene_approx_convex_partition_2()` */ template< typename Kernel, typename Container > @@ -55,7 +55,7 @@ It is by default `std::vector`. \cgalModels `PolygonConvexDecomposition_2` -\sa `CGAL::approx_convex_partition_2` +\sa `CGAL::approx_convex_partition_2()` */ template< typename Kernel, typename Container > @@ -89,7 +89,7 @@ It is by default `std::vector`. \cgalModels `PolygonConvexDecomposition_2` -\sa `CGAL::optimal_convex_partition_2` +\sa `CGAL::optimal_convex_partition_2()` */ template< typename Kernel, typename Container > diff --git a/Number_types/doc/Number_types/CGAL/Root_of_traits.h b/Number_types/doc/Number_types/CGAL/Root_of_traits.h index 5d9dada2096..b5a67d2fbff 100644 --- a/Number_types/doc/Number_types/CGAL/Root_of_traits.h +++ b/Number_types/doc/Number_types/CGAL/Root_of_traits.h @@ -17,8 +17,8 @@ Multiplicities are not reported. \sa `RootOf_2` \sa `CGAL::Root_of_traits` -\sa `CGAL::make_root_of_2` -\sa `CGAL::make_sqrt` +\sa `CGAL::make_root_of_2()` +\sa `CGAL::make_sqrt()` \sa `CGAL::Sqrt_extension` */ @@ -44,8 +44,8 @@ Returns the smallest real root of the polynomial \f$ aX^2+bX+c\f$ if \sa `RootOf_2` \sa `CGAL::Root_of_traits` -\sa `CGAL::make_sqrt` -\sa `CGAL::compute_roots_of_2` +\sa `CGAL::make_sqrt()` +\sa `CGAL::compute_roots_of_2()` \sa `CGAL::Sqrt_extension` */ template @@ -66,8 +66,8 @@ Constructs the number \f$ \alpha+ \beta\sqrt{\gamma}\f$. \sa `RootOf_2` \sa `CGAL::Root_of_traits` -\sa `CGAL::make_sqrt` -\sa `CGAL::compute_roots_of_2` +\sa `CGAL::make_sqrt()` +\sa `CGAL::compute_roots_of_2()` \sa `CGAL::Sqrt_extension` */ template @@ -90,7 +90,7 @@ can represent algebraic extensions of degree \f$ 2\f$. \pre \f$ x \leq0 \f$ \sa `RootOf_2` -\sa `CGAL::make_root_of_2` +\sa `CGAL::make_root_of_2()` \sa `CGAL::Root_of_traits` */ template Root_of_traits::Root_of_2 make_sqrt(const RT& x); @@ -109,8 +109,8 @@ algebraic numbers of degree 2 over `RT`. Moreover, the class provides `Root_of_1`, which represents the quotient field of `RT`. \sa `RootOf_2` -\sa `CGAL::compute_roots_of_2` -\sa `CGAL::make_root_of_2` +\sa `CGAL::compute_roots_of_2()` +\sa `CGAL::make_root_of_2()` */ template< typename RT > diff --git a/Number_types/doc/Number_types/CGAL/simplest_rational_in_interval.h b/Number_types/doc/Number_types/CGAL/simplest_rational_in_interval.h index e83c799d132..170f1b7e7e2 100644 --- a/Number_types/doc/Number_types/CGAL/simplest_rational_in_interval.h +++ b/Number_types/doc/Number_types/CGAL/simplest_rational_in_interval.h @@ -14,7 +14,7 @@ interval of two `double` values. See Knuth, "Seminumerical algorithms", page 654, answer to exercise 4.53-39. -\sa `CGAL::to_rational` +\sa `CGAL::to_rational()` */ template diff --git a/Number_types/doc/Number_types/CGAL/to_rational.h b/Number_types/doc/Number_types/CGAL/to_rational.h index 7d929af8808..9930106cd81 100644 --- a/Number_types/doc/Number_types/CGAL/to_rational.h +++ b/Number_types/doc/Number_types/CGAL/to_rational.h @@ -8,7 +8,7 @@ computes the rational number that equals `d`. The function `to_rational` computes the rational number representing a given double precision floating point number. -\sa `CGAL::simplest_rational_in_interval` +\sa `CGAL::simplest_rational_in_interval()` */ template Rational to_rational(double d); diff --git a/Partition_2/doc/Partition_2/CGAL/Partition_traits_2.h b/Partition_2/doc/Partition_2/CGAL/Partition_traits_2.h index f7881ad9cb2..88290a96e0a 100644 --- a/Partition_2/doc/Partition_2/CGAL/Partition_traits_2.h +++ b/Partition_2/doc/Partition_2/CGAL/Partition_traits_2.h @@ -14,14 +14,14 @@ a representation class `R`. \cgalModels `YMonotonePartitionIsValidTraits_2` \cgalModels `YMonotonePartitionTraits_2` -\sa `CGAL::approx_convex_partition_2` -\sa `CGAL::convex_partition_is_valid_2` -\sa `CGAL::greene_approx_convex_partition_2` -\sa `CGAL::optimal_convex_partition_2` -\sa `CGAL::partition_is_valid_2` +\sa `CGAL::approx_convex_partition_2()` +\sa `CGAL::convex_partition_is_valid_2()` +\sa `CGAL::greene_approx_convex_partition_2()` +\sa `CGAL::optimal_convex_partition_2()` +\sa `CGAL::partition_is_valid_2()` \sa `CGAL::Partition_is_valid_traits_2` -\sa `CGAL::y_monotone_partition_2` -\sa `CGAL::y_monotone_partition_is_valid_2` +\sa `CGAL::y_monotone_partition_2()` +\sa `CGAL::y_monotone_partition_is_valid_2()` */ template< typename R > diff --git a/Partition_2/doc/Partition_2/CGAL/is_y_monotone_2.h b/Partition_2/doc/Partition_2/CGAL/is_y_monotone_2.h index 1edfa1b9e80..06cde3ab9f6 100644 --- a/Partition_2/doc/Partition_2/CGAL/is_y_monotone_2.h +++ b/Partition_2/doc/Partition_2/CGAL/is_y_monotone_2.h @@ -17,8 +17,8 @@ The default traits class `Default_traits` is the kernel in which the type `std::iterator_traits::%value_type` is defined. \sa `CGAL::Is_y_monotone_2` -\sa `CGAL::y_monotone_partition_2` -\sa `CGAL::y_monotone_partition_is_valid_2` +\sa `CGAL::y_monotone_partition_2()` +\sa `CGAL::y_monotone_partition_is_valid_2()` \cgalHeading{Implementation} diff --git a/Partition_2/doc/Partition_2/CGAL/partition_2.h b/Partition_2/doc/Partition_2/CGAL/partition_2.h index ddf40349c4d..b90dcd14630 100644 --- a/Partition_2/doc/Partition_2/CGAL/partition_2.h +++ b/Partition_2/doc/Partition_2/CGAL/partition_2.h @@ -34,12 +34,12 @@ whose vertices are oriented counterclockwise. The default traits class `Default_traits` is `Partition_traits_2`, with the representation type determined by `std::iterator_traits::%value_type`. -\sa `CGAL::convex_partition_is_valid_2` -\sa `CGAL::greene_approx_convex_partition_2` -\sa `CGAL::optimal_convex_partition_2` -\sa `CGAL::partition_is_valid_2` +\sa `CGAL::convex_partition_is_valid_2()` +\sa `CGAL::greene_approx_convex_partition_2()` +\sa `CGAL::optimal_convex_partition_2()` +\sa `CGAL::partition_is_valid_2()` \sa `CGAL::Partition_is_valid_traits_2` -\sa `CGAL::y_monotone_partition_2` +\sa `CGAL::y_monotone_partition_2()` \cgalHeading{Implementation} @@ -108,11 +108,11 @@ an object of type `Traits::Polygon_2`. The default traits class `Default_traits` is `Partition_traits_2`, with the representation type determined by `std::iterator_traits::%value_type`. -\sa `CGAL::approx_convex_partition_2` -\sa `CGAL::convex_partition_is_valid_2` -\sa `CGAL::optimal_convex_partition_2` -\sa `CGAL::partition_is_valid_2` -\sa `CGAL::y_monotone_partition_2` +\sa `CGAL::approx_convex_partition_2()` +\sa `CGAL::convex_partition_is_valid_2()` +\sa `CGAL::optimal_convex_partition_2()` +\sa `CGAL::partition_is_valid_2()` +\sa `CGAL::y_monotone_partition_2()` \cgalHeading{Implementation} @@ -176,10 +176,10 @@ of type `Traits::Polygon_2`. The default traits class `Default_traits` is `Partition_traits_2`, with the representation type determined by `std::iterator_traits::%value_type`. -\sa `CGAL::approx_convex_partition_2` -\sa `CGAL::convex_partition_is_valid_2` -\sa `CGAL::greene_approx_convex_partition_2` -\sa `CGAL::partition_is_valid_2` +\sa `CGAL::approx_convex_partition_2()` +\sa `CGAL::convex_partition_is_valid_2()` +\sa `CGAL::greene_approx_convex_partition_2()` +\sa `CGAL::partition_is_valid_2()` \sa `CGAL::Partition_is_valid_traits_2` \cgalHeading{Implementation} @@ -247,11 +247,11 @@ of type `Traits::Polygon_2`. The default traits class `Default_traits` is `Partition_traits_2`, with the representation type determined by `std::iterator_traits::%value_type`. -\sa `CGAL::approx_convex_partition_2` -\sa `CGAL::greene_approx_convex_partition_2` -\sa `CGAL::optimal_convex_partition_2` -\sa `CGAL::partition_is_valid_2` -\sa `CGAL::y_monotone_partition_is_valid_2` +\sa `CGAL::approx_convex_partition_2()` +\sa `CGAL::greene_approx_convex_partition_2()` +\sa `CGAL::optimal_convex_partition_2()` +\sa `CGAL::partition_is_valid_2()` +\sa `CGAL::y_monotone_partition_is_valid_2()` \cgalHeading{Implementation} diff --git a/Partition_2/doc/Partition_2/CGAL/partition_is_valid_2.h b/Partition_2/doc/Partition_2/CGAL/partition_is_valid_2.h index 0c70a9259fa..afcca9a1f4b 100644 --- a/Partition_2/doc/Partition_2/CGAL/partition_is_valid_2.h +++ b/Partition_2/doc/Partition_2/CGAL/partition_is_valid_2.h @@ -31,11 +31,11 @@ returns `false`. The default traits class `Default_traits` is `Partition_traits_2`, with the representation type determined by `std::iterator_traits::%value_type`. -\sa `CGAL::approx_convex_partition_2` -\sa `CGAL::greene_approx_convex_partition_2` -\sa `CGAL::optimal_convex_partition_2` -\sa `CGAL::partition_is_valid_2` -\sa `CGAL::is_convex_2` +\sa `CGAL::approx_convex_partition_2()` +\sa `CGAL::greene_approx_convex_partition_2()` +\sa `CGAL::optimal_convex_partition_2()` +\sa `CGAL::partition_is_valid_2()` +\sa `CGAL::is_convex_2()` \cgalHeading{Implementation} @@ -93,13 +93,13 @@ tested by `Traits::Is_valid()`. The default traits class `Default_traits` is `Partition_traits_2`, with the representation type determined by `std::iterator_traits::%value_type`. -\sa `CGAL::approx_convex_partition_2` -\sa `CGAL::greene_approx_convex_partition_2` -\sa `CGAL::is_y_monotone_2` -\sa `CGAL::optimal_convex_partition_2` +\sa `CGAL::approx_convex_partition_2()` +\sa `CGAL::greene_approx_convex_partition_2()` +\sa `CGAL::is_y_monotone_2()` +\sa `CGAL::optimal_convex_partition_2()` \sa `CGAL::Partition_is_valid_traits_2` -\sa `CGAL::y_monotone_partition_2` -\sa `CGAL::is_convex_2` +\sa `CGAL::y_monotone_partition_2()` +\sa `CGAL::is_convex_2()` \cgalHeading{Implementation} @@ -153,9 +153,9 @@ returns false. The default traits class `Default_traits` is `Partition_traits_2`, with the representation type determined by `std::iterator_traits::%value_type`. -\sa `CGAL::y_monotone_partition_2` -\sa `CGAL::is_y_monotone_2` -\sa `CGAL::partition_is_valid_2` +\sa `CGAL::y_monotone_partition_2()` +\sa `CGAL::is_y_monotone_2()` +\sa `CGAL::partition_is_valid_2()` \sa `CGAL::Partition_is_valid_traits_2` \cgalHeading{Implementation} diff --git a/Partition_2/doc/Partition_2/CGAL/polygon_function_objects.h b/Partition_2/doc/Partition_2/CGAL/polygon_function_objects.h index 5fbf1aca5f3..aeeac228e3b 100644 --- a/Partition_2/doc/Partition_2/CGAL/polygon_function_objects.h +++ b/Partition_2/doc/Partition_2/CGAL/polygon_function_objects.h @@ -8,7 +8,7 @@ a convex polygon or not. \cgalModels `PolygonIsValid` -\sa `CGAL::convex_partition_is_valid_2` +\sa `CGAL::convex_partition_is_valid_2()` \sa `CGAL::Partition_is_valid_traits_2` \cgalHeading{Implementation} @@ -57,7 +57,7 @@ Function object class that indicates all sequences of points are valid. \cgalModels `PolygonIsValid` -\sa `CGAL::partition_is_valid_2` +\sa `CGAL::partition_is_valid_2()` \sa `CGAL::Partition_is_valid_traits_2` \cgalHeading{Implementation} @@ -105,7 +105,7 @@ a \f$ y\f$-monotone polygon or not. \cgalModels `PolygonIsValid` -\sa `CGAL::convex_partition_is_valid_2` +\sa `CGAL::convex_partition_is_valid_2()` \sa `CGAL::Partition_is_valid_traits_2` \cgalHeading{Implementation} diff --git a/Partition_2/doc/Partition_2/Concepts/ConvexPartitionIsValidTraits_2.h b/Partition_2/doc/Partition_2/Concepts/ConvexPartitionIsValidTraits_2.h index b22e3841c55..129d67b067c 100644 --- a/Partition_2/doc/Partition_2/Concepts/ConvexPartitionIsValidTraits_2.h +++ b/Partition_2/doc/Partition_2/Concepts/ConvexPartitionIsValidTraits_2.h @@ -8,10 +8,10 @@ convex partition of a polygon. \cgalHasModel `CGAL::Partition_traits_2` -\sa `CGAL::approx_convex_partition_2` -\sa `CGAL::greene_approx_convex_partition_2` +\sa `CGAL::approx_convex_partition_2()` +\sa `CGAL::greene_approx_convex_partition_2()` \sa `CGAL::Is_convex_2` -\sa `CGAL::optimal_convex_partition_2` +\sa `CGAL::optimal_convex_partition_2()` */ diff --git a/Partition_2/doc/Partition_2/Concepts/IsYMonotoneTraits_2.h b/Partition_2/doc/Partition_2/Concepts/IsYMonotoneTraits_2.h index 591433f651a..38cccc8cfd7 100644 --- a/Partition_2/doc/Partition_2/Concepts/IsYMonotoneTraits_2.h +++ b/Partition_2/doc/Partition_2/Concepts/IsYMonotoneTraits_2.h @@ -10,8 +10,8 @@ used with the function `is_y_monotone_2` that tests whether a sequence of \cgalHasModel `CGAL::Kernel_traits_2` \sa `CGAL::Is_y_monotone_2` -\sa `CGAL::y_monotone_partition_2` -\sa `CGAL::y_monotone_partition_is_valid_2` +\sa `CGAL::y_monotone_partition_2()` +\sa `CGAL::y_monotone_partition_is_valid_2()` */ diff --git a/Partition_2/doc/Partition_2/Concepts/OptimalConvexPartitionTraits_2.h b/Partition_2/doc/Partition_2/Concepts/OptimalConvexPartitionTraits_2.h index e1fa3c878a0..227b7a84563 100644 --- a/Partition_2/doc/Partition_2/Concepts/OptimalConvexPartitionTraits_2.h +++ b/Partition_2/doc/Partition_2/Concepts/OptimalConvexPartitionTraits_2.h @@ -10,7 +10,7 @@ an optimal convex partition of a polygon. \cgalHasModel `CGAL::Partition_traits_2` -\sa `CGAL::convex_partition_is_valid_2` +\sa `CGAL::convex_partition_is_valid_2()` \sa `CGAL::Partition_is_valid_traits_2` */ diff --git a/Partition_2/doc/Partition_2/Concepts/PartitionIsValidTraits_2.h b/Partition_2/doc/Partition_2/Concepts/PartitionIsValidTraits_2.h index 279fca4fe97..302e3899a31 100644 --- a/Partition_2/doc/Partition_2/Concepts/PartitionIsValidTraits_2.h +++ b/Partition_2/doc/Partition_2/Concepts/PartitionIsValidTraits_2.h @@ -16,10 +16,10 @@ for testing for convexity and \f$ y\f$-monotonicity, respectively. \cgalHasModel `CGAL::Partition_is_valid_traits_2` -\sa `CGAL::approx_convex_partition_2` -\sa `CGAL::greene_approx_convex_partition_2` -\sa `CGAL::optimal_convex_partition_2` -\sa `CGAL::y_monotone_partition_2` +\sa `CGAL::approx_convex_partition_2()` +\sa `CGAL::greene_approx_convex_partition_2()` +\sa `CGAL::optimal_convex_partition_2()` +\sa `CGAL::y_monotone_partition_2()` */ diff --git a/Partition_2/doc/Partition_2/Concepts/PartitionTraits_2.h b/Partition_2/doc/Partition_2/Concepts/PartitionTraits_2.h index d8841a0f4a5..0bee74ea3df 100644 --- a/Partition_2/doc/Partition_2/Concepts/PartitionTraits_2.h +++ b/Partition_2/doc/Partition_2/Concepts/PartitionTraits_2.h @@ -10,10 +10,10 @@ requirements. \cgalHasModel `CGAL::Partition_traits_2` -\sa `CGAL::approx_convex_partition_2` -\sa `CGAL::greene_approx_convex_partition_2` -\sa `CGAL::optimal_convex_partition_2` -\sa `CGAL::y_monotone_partition_2` +\sa `CGAL::approx_convex_partition_2()` +\sa `CGAL::greene_approx_convex_partition_2()` +\sa `CGAL::optimal_convex_partition_2()` +\sa `CGAL::y_monotone_partition_2()` */ diff --git a/Partition_2/doc/Partition_2/Concepts/PolygonIsValid.h b/Partition_2/doc/Partition_2/Concepts/PolygonIsValid.h index 2d3f69bde2c..cf55328742c 100644 --- a/Partition_2/doc/Partition_2/Concepts/PolygonIsValid.h +++ b/Partition_2/doc/Partition_2/Concepts/PolygonIsValid.h @@ -9,13 +9,13 @@ meanings (e.g., convex or \f$ y\f$-monotone). \cgalHasModel `CGAL::Is_convex_2` \cgalHasModel `CGAL::Is_y_monotone_2` -\sa `CGAL::approx_convex_partition_2` -\sa `CGAL::convex_partition_is_valid_2` -\sa `CGAL::greene_approx_convex_partition_2` -\sa `CGAL::optimal_convex_partition_2` -\sa `CGAL::partition_is_valid_2` -\sa `CGAL::y_monotone_partition_2` -\sa `CGAL::y_monotone_partition_is_valid_2` +\sa `CGAL::approx_convex_partition_2()` +\sa `CGAL::convex_partition_is_valid_2()` +\sa `CGAL::greene_approx_convex_partition_2()` +\sa `CGAL::optimal_convex_partition_2()` +\sa `CGAL::partition_is_valid_2()` +\sa `CGAL::y_monotone_partition_2()` +\sa `CGAL::y_monotone_partition_is_valid_2()` */ diff --git a/Partition_2/doc/Partition_2/Concepts/YMonotonePartitionIsValidTraits_2.h b/Partition_2/doc/Partition_2/Concepts/YMonotonePartitionIsValidTraits_2.h index 30c5885c3b8..b8d58a85e84 100644 --- a/Partition_2/doc/Partition_2/Concepts/YMonotonePartitionIsValidTraits_2.h +++ b/Partition_2/doc/Partition_2/Concepts/YMonotonePartitionIsValidTraits_2.h @@ -8,8 +8,8 @@ by `y_monotone_partition_is_valid_2` for testing the validity of a \cgalHasModel `CGAL::Partition_traits_2` -\sa `CGAL::partition_is_valid_2` -\sa `CGAL::y_monotone_partition_2` +\sa `CGAL::partition_is_valid_2()` +\sa `CGAL::y_monotone_partition_2()` */ diff --git a/Polygon/include/CGAL/Polygon_2_algorithms.h b/Polygon/include/CGAL/Polygon_2_algorithms.h index fc67f4daa35..058f92a88a8 100644 --- a/Polygon/include/CGAL/Polygon_2_algorithms.h +++ b/Polygon/include/CGAL/Polygon_2_algorithms.h @@ -55,9 +55,9 @@ namespace CGAL { /// \cgalRequires The value type of `ForwardIterator` must be `Traits::Point_2`, /// /// -/// \sa `CGAL::right_vertex_2` -/// \sa `CGAL::top_vertex_2` -/// \sa `CGAL::bottom_vertex_2` +/// \sa `CGAL::right_vertex_2()` +/// \sa `CGAL::top_vertex_2()` +/// \sa `CGAL::bottom_vertex_2()` /// \sa `CGAL::Polygon_2` template ForwardIterator left_vertex_2(ForwardIterator first, @@ -74,9 +74,9 @@ ForwardIterator left_vertex_2(ForwardIterator first, /// `less_xy_2_object()` are used. /// \cgalRequires The value type of `ForwardIterator` must be `Traits::Point_2`. /// -/// \sa `CGAL::left_vertex_2` -/// \sa `CGAL::top_vertex_2` -/// \sa `CGAL::bottom_vertex_2` +/// \sa `CGAL::left_vertex_2()` +/// \sa `CGAL::top_vertex_2()` +/// \sa `CGAL::bottom_vertex_2()` /// \sa `CGAL::Polygon_2` template ForwardIterator right_vertex_2(ForwardIterator first, @@ -93,9 +93,9 @@ ForwardIterator right_vertex_2(ForwardIterator first, /// `less_yx_2_object()` are used. /// \cgalRequires The value type of `ForwardIterator` must be `Traits::Point_2`. /// -/// \sa `CGAL::left_vertex_2` -/// \sa `CGAL::right_vertex_2` -/// \sa `CGAL::bottom_vertex_2` +/// \sa `CGAL::left_vertex_2()` +/// \sa `CGAL::right_vertex_2()` +/// \sa `CGAL::bottom_vertex_2()` /// \sa `CGAL::Polygon_2` template ForwardIterator top_vertex_2(ForwardIterator first, @@ -112,9 +112,9 @@ ForwardIterator top_vertex_2(ForwardIterator first, /// `less_yx_2_object()` are used. /// \cgalRequires The value type of `ForwardIterator` must be `Traits::Point_2`. /// -/// \sa `CGAL::left_vertex_2` -/// \sa `CGAL::right_vertex_2` -/// \sa `CGAL::top_vertex_2` +/// \sa `CGAL::left_vertex_2()` +/// \sa `CGAL::right_vertex_2()` +/// \sa `CGAL::top_vertex_2()` /// \sa `CGAL::Polygon_2` /// \sa `PolygonTraits_2` template @@ -153,9 +153,9 @@ Bbox_2 bbox_2(InputIterator first, /// - `compute_area_2_object()` /// \cgalRequires The value type of `ForwardIterator` must be `Traits::Point_2`. /// -/// \sa `CGAL::polygon_area_2` +/// \sa `CGAL::polygon_area_2()` /// \sa `PolygonTraits_2` -/// \sa `CGAL::orientation_2` +/// \sa `CGAL::orientation_2()` /// \sa `CGAL::Polygon_2` template void @@ -281,8 +281,8 @@ bool is_simple_2(ForwardIterator first, /// \cgalRequires The value type of `ForwardIterator` must be `PolygonTraits::Point_2`, /// /// \sa `PolygonTraits_2` -/// \sa `CGAL::bounded_side_2` -/// \sa `CGAL::is_simple_2` +/// \sa `CGAL::bounded_side_2()` +/// \sa `CGAL::is_simple_2()` /// \sa `CGAL::Polygon_2` /// \sa `Oriented_side` template @@ -321,7 +321,7 @@ Oriented_side oriented_side_2(ForwardIterator first, /// /// /// \sa `PolygonTraits_2` -/// \sa `CGAL::oriented_side_2` +/// \sa `CGAL::oriented_side_2()` /// \sa `CGAL::Polygon_2 ` /// \sa \ref CGAL::Bounded_side template @@ -344,7 +344,7 @@ Bounded_side bounded_side_2(ForwardIterator first, /// /// /// \sa `PolygonTraits_2` -/// \sa `CGAL::is_simple_2` +/// \sa `CGAL::is_simple_2()` /// \sa `CGAL::Polygon_2` /// \sa `CGAL::Orientation` template diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PrincipalSturmHabichtSequence.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PrincipalSturmHabichtSequence.h index abca7b166c8..c95832dcf65 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PrincipalSturmHabichtSequence.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PrincipalSturmHabichtSequence.h @@ -25,7 +25,7 @@ the polynomial \f$ f\f$. \sa `Polynomial_d` \sa `PolynomialTraits_d` -\sa `CGAL::number_of_real_roots` +\sa `CGAL::number_of_real_roots()` \sa `PolynomialTraits_d::Resultant` \sa `PolynomialTraits_d::SturmHabichtSequence` \sa `PolynomialTraits_d::PrincipalSubresultants` diff --git a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/all_furthest_neighbors_2.h b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/all_furthest_neighbors_2.h index 454447bbe8e..566eb068066 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/all_furthest_neighbors_2.h +++ b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/all_furthest_neighbors_2.h @@ -35,7 +35,7 @@ for `AllFurthestNeighborsTraits_2`. \sa `AllFurthestNeighborsTraits_2` -\sa `CGAL::monotone_matrix_search` +\sa `CGAL::monotone_matrix_search()` \cgalHeading{Implementation} diff --git a/Polytope_distance_d/doc/Polytope_distance_d/Concepts/AllFurthestNeighborsTraits_2.h b/Polytope_distance_d/doc/Polytope_distance_d/Concepts/AllFurthestNeighborsTraits_2.h index 0b5e531e2f5..c792b310c45 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/Concepts/AllFurthestNeighborsTraits_2.h +++ b/Polytope_distance_d/doc/Polytope_distance_d/Concepts/AllFurthestNeighborsTraits_2.h @@ -12,7 +12,7 @@ convex polygon using the function `all_furthest_neighbors_2`. \cgalHasModel `CGAL::Simple_cartesian` \cgalHasModel `CGAL::Simple_homogeneous` -\sa `CGAL::all_furthest_neighbors_2` +\sa `CGAL::all_furthest_neighbors_2()` ### Notes ### diff --git a/STL_Extension/doc/STL_Extension/CGAL/algorithm.h b/STL_Extension/doc/STL_Extension/CGAL/algorithm.h index 11fc59285d5..eafc4894583 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/algorithm.h +++ b/STL_Extension/doc/STL_Extension/CGAL/algorithm.h @@ -97,7 +97,7 @@ instead. The function `predecessor` returns the previous iterator, i.e. the result of `operator--` on a bidirectional iterator. -\sa `CGAL::successor` +\sa `CGAL::successor()` \returns `--it`. */ @@ -119,7 +119,7 @@ The function `successor` returns the next iterator, i.e. the result of `operator++` on a forward iterator. -\sa `CGAL::predecessor` +\sa `CGAL::predecessor()` \returns `++it`. */ @@ -145,7 +145,7 @@ is used. \sa boost::next -\sa `CGAL::cpp11::prev` +\sa `CGAL::cpp11::prev()` */ template diff --git a/STL_Extension/doc/STL_Extension/CGAL/function_objects.h b/STL_Extension/doc/STL_Extension/CGAL/function_objects.h index 0d6fcba61da..67f632341bf 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/function_objects.h +++ b/STL_Extension/doc/STL_Extension/CGAL/function_objects.h @@ -93,7 +93,7 @@ are combined. -\sa `CGAL::compare_to_less` +\sa `CGAL::compare_to_less()` */ diff --git a/STL_Extension/doc/STL_Extension/CGAL/iterator.h b/STL_Extension/doc/STL_Extension/CGAL/iterator.h index 88fcbd3eeee..5d3d6e55182 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/iterator.h +++ b/STL_Extension/doc/STL_Extension/CGAL/iterator.h @@ -63,7 +63,7 @@ from input iterators. `Iterator` is a model for `InputIterator`. -\sa `CGAL::copy_n` +\sa `CGAL::copy_n()` */ diff --git a/Stream_support/doc/IOstream/CGAL/IO/io.h b/Stream_support/doc/IOstream/CGAL/IO/io.h index 65f0706ec00..31565d8734c 100644 --- a/Stream_support/doc/IOstream/CGAL/IO/io.h +++ b/Stream_support/doc/IOstream/CGAL/IO/io.h @@ -23,14 +23,14 @@ would be `PointC2(0.0, 0.0)`. At the moment \cgal does not provide input operations for pretty printed data. By default a stream is in Ascii mode. -\sa `CGAL::set_mode` -\sa `CGAL::set_ascii_mode` +\sa `CGAL::set_mode()` +\sa `CGAL::set_ascii_mode()` \sa `CGAL::set_binary_mode ` \sa `CGAL::set_pretty_mode ` -\sa `CGAL::get_mode` -\sa `CGAL::is_ascii` -\sa `CGAL::is_binary` -\sa `CGAL::is_pretty` +\sa `CGAL::get_mode()` +\sa `CGAL::is_ascii()` +\sa `CGAL::is_binary()` +\sa `CGAL::is_pretty()` */ enum Mode { ASCII = 0, BINARY, PRETTY }; @@ -40,13 +40,13 @@ enum Mode { ASCII = 0, BINARY, PRETTY }; returns the printing mode of the IO stream `s`. \sa `CGAL::Mode` -\sa `CGAL::set_mode` -\sa `CGAL::set_ascii_mode` -\sa `CGAL::set_binary_mode` -\sa `CGAL::set_pretty_mode` -\sa `CGAL::is_ascii` -\sa `CGAL::is_binary` -\sa `CGAL::is_pretty` +\sa `CGAL::set_mode()` +\sa `CGAL::set_ascii_mode()` +\sa `CGAL::set_binary_mode()` +\sa `CGAL::set_pretty_mode()` +\sa `CGAL::is_ascii()` +\sa `CGAL::is_binary()` +\sa `CGAL::is_pretty()` */ @@ -60,13 +60,13 @@ Returns the previous mode of `s`. \sa `CGAL::Mode` -\sa `CGAL::set_mode` -\sa `CGAL::set_binary_mode` -\sa `CGAL::set_pretty_mode` -\sa `CGAL::get_mode` -\sa `CGAL::is_ascii` -\sa `CGAL::is_binary` -\sa `CGAL::is_pretty` +\sa `CGAL::set_mode()` +\sa `CGAL::set_binary_mode()` +\sa `CGAL::set_pretty_mode()` +\sa `CGAL::get_mode()` +\sa `CGAL::is_ascii()` +\sa `CGAL::is_binary()` +\sa `CGAL::is_pretty()` */ Mode set_ascii_mode(std::ios& s); @@ -74,13 +74,13 @@ Mode set_ascii_mode(std::ios& s); \ingroup PkgIOstreams \sa `CGAL::Mode` -\sa `CGAL::set_mode` -\sa `CGAL::set_ascii_mode` -\sa `CGAL::set_pretty_mode` -\sa `CGAL::get_mode` -\sa `CGAL::is_ascii` -\sa `CGAL::is_binary` -\sa `CGAL::is_pretty` +\sa `CGAL::set_mode()` +\sa `CGAL::set_ascii_mode()` +\sa `CGAL::set_pretty_mode()` +\sa `CGAL::get_mode()` +\sa `CGAL::is_ascii()` +\sa `CGAL::is_binary()` +\sa `CGAL::is_pretty()` sets the mode of the IO stream `s` to be the `BINARY` mode. Returns the previous mode of `s`. @@ -93,13 +93,13 @@ Mode set_binary_mode(std::ios& s); sets the printing mode of the IO stream `s`. \sa `CGAL::Mode` -\sa `CGAL::set_ascii_mode` -\sa `CGAL::set_binary_mode` -\sa `CGAL::set_pretty_mode` -\sa `CGAL::get_mode` -\sa `CGAL::is_ascii` -\sa `CGAL::is_binary` -\sa `CGAL::is_pretty` +\sa `CGAL::set_ascii_mode()` +\sa `CGAL::set_binary_mode()` +\sa `CGAL::set_pretty_mode()` +\sa `CGAL::get_mode()` +\sa `CGAL::is_ascii()` +\sa `CGAL::is_binary()` +\sa `CGAL::is_pretty()` */ Mode set_mode(std::ios& s, IO::Mode m); @@ -110,13 +110,13 @@ sets the mode of the IO stream `s` to be the `PRETTY` mode. Returns the previous mode of `s`. \sa `CGAL::Mode` -\sa `CGAL::set_mode` -\sa `CGAL::set_ascii_mode` -\sa `CGAL::set_binary_mode` -\sa `CGAL::get_mode` -\sa `CGAL::is_ascii` -\sa `CGAL::is_binary` -\sa `CGAL::is_pretty` +\sa `CGAL::set_mode()` +\sa `CGAL::set_ascii_mode()` +\sa `CGAL::set_binary_mode()` +\sa `CGAL::get_mode()` +\sa `CGAL::is_ascii()` +\sa `CGAL::is_binary()` +\sa `CGAL::is_pretty()` */ Mode set_pretty_mode(std::ios& s); @@ -165,13 +165,13 @@ class Output_rep { checks if the IO stream `s` is in `ASCII` mode. \sa `CGAL::Mode` -\sa `CGAL::set_mode` -\sa `CGAL::set_ascii_mode` -\sa `CGAL::set_binary_mode` -\sa `CGAL::set_pretty_mode` -\sa `CGAL::get_mode` -\sa `CGAL::is_binary` -\sa `CGAL::is_pretty` +\sa `CGAL::set_mode()` +\sa `CGAL::set_ascii_mode()` +\sa `CGAL::set_binary_mode()` +\sa `CGAL::set_pretty_mode()` +\sa `CGAL::get_mode()` +\sa `CGAL::is_binary()` +\sa `CGAL::is_pretty()` */ bool is_ascii(std::ios& s); @@ -182,13 +182,13 @@ bool is_ascii(std::ios& s); checks if the IO stream `s` is in `BINARY` mode. \sa `CGAL::Mode` -\sa `CGAL::set_mode` -\sa `CGAL::set_ascii_mode` -\sa `CGAL::set_binary_mode` -\sa `CGAL::set_pretty_mode` -\sa `CGAL::get_mode` -\sa `CGAL::is_ascii` -\sa `CGAL::is_pretty` +\sa `CGAL::set_mode()` +\sa `CGAL::set_ascii_mode()` +\sa `CGAL::set_binary_mode()` +\sa `CGAL::set_pretty_mode()` +\sa `CGAL::get_mode()` +\sa `CGAL::is_ascii()` +\sa `CGAL::is_pretty()` */ bool is_binary(std::ios& s); @@ -198,13 +198,13 @@ bool is_binary(std::ios& s); checks if the IO stream `s` is in `PRETTY` mode. \sa `CGAL::Mode` -\sa `CGAL::set_mode` -\sa `CGAL::set_ascii_mode` -\sa `CGAL::set_binary_mode` -\sa `CGAL::set_pretty_mode` -\sa `CGAL::get_mode` -\sa `CGAL::is_ascii` -\sa `CGAL::is_binary` +\sa `CGAL::set_mode()` +\sa `CGAL::set_ascii_mode()` +\sa `CGAL::set_binary_mode()` +\sa `CGAL::set_pretty_mode()` +\sa `CGAL::get_mode()` +\sa `CGAL::is_ascii()` +\sa `CGAL::is_binary()` */ bool is_pretty(std::ios& s); @@ -248,14 +248,14 @@ as `cout` or `cerr`, as well as to `std::ostringstream` and `std::ofstream`. The output operator is defined for all classes in the \cgal `Kernel` and for the class `Color` as well. -\sa `CGAL::set_mode` -\sa `CGAL::set_ascii_mode` -\sa `CGAL::set_binary_mode` -\sa `CGAL::set_pretty_mode` -\sa `CGAL::get_mode` -\sa `CGAL::is_ascii` -\sa `CGAL::is_binary` -\sa `CGAL::is_pretty` +\sa `CGAL::set_mode()` +\sa `CGAL::set_ascii_mode()` +\sa `CGAL::set_binary_mode()` +\sa `CGAL::set_pretty_mode()` +\sa `CGAL::get_mode()` +\sa `CGAL::is_ascii()` +\sa `CGAL::is_binary()` +\sa `CGAL::is_pretty()` \sa \ref op_right_shift "CGAL::operator>>" */ ostream& operator<<(ostream& os, Class c); @@ -272,14 +272,14 @@ The input operator is defined for all classes in the \cgal `Kernel`. -\sa `CGAL::set_mode` -\sa `CGAL::set_ascii_mode` -\sa `CGAL::set_binary_mode` -\sa `CGAL::set_pretty_mode` -\sa `CGAL::get_mode` -\sa `CGAL::is_ascii` -\sa `CGAL::is_binary` -\sa `CGAL::is_pretty` +\sa `CGAL::set_mode()` +\sa `CGAL::set_ascii_mode()` +\sa `CGAL::set_binary_mode()` +\sa `CGAL::set_pretty_mode()` +\sa `CGAL::get_mode()` +\sa `CGAL::is_ascii()` +\sa `CGAL::is_binary()` +\sa `CGAL::is_pretty()` \sa \ref PkgIOstreams_op_left_shift "CGAL::operator<<" */ istream& operator>>(istream& is, Class c); diff --git a/Surface_mesher/doc/Surface_mesher/Concepts/ImplicitFunction.h b/Surface_mesher/doc/Surface_mesher/Concepts/ImplicitFunction.h index 79d421fc98c..e808638b561 100644 --- a/Surface_mesher/doc/Surface_mesher/Concepts/ImplicitFunction.h +++ b/Surface_mesher/doc/Surface_mesher/Concepts/ImplicitFunction.h @@ -11,7 +11,7 @@ whose `operator()` computes the values of a function \cgalHasModel any pointer to a function of type `FT (*)(Point)` \sa `CGAL::Implicit_surface_3` -\sa `CGAL::make_surface_mesh` +\sa `CGAL::make_surface_mesh()` */ diff --git a/Surface_mesher/doc/Surface_mesher/Concepts/ImplicitSurfaceTraits_3.h b/Surface_mesher/doc/Surface_mesher/Concepts/ImplicitSurfaceTraits_3.h index efdb4b32ffe..70119c0b14a 100644 --- a/Surface_mesher/doc/Surface_mesher/Concepts/ImplicitSurfaceTraits_3.h +++ b/Surface_mesher/doc/Surface_mesher/Concepts/ImplicitSurfaceTraits_3.h @@ -18,7 +18,7 @@ to the generated model of `SurfaceMeshTraits_3`. \cgalHasModel Any \cgal Kernel. \sa `CGAL::Implicit_surface_3` -\sa `CGAL::make_surface_mesh` +\sa `CGAL::make_surface_mesh()` */ diff --git a/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshCellBase_3.h b/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshCellBase_3.h index fbf1f612fe3..22c79c937a6 100644 --- a/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshCellBase_3.h +++ b/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshCellBase_3.h @@ -43,7 +43,7 @@ the center of its biggest Delaunay surface ball. \sa `SurfaceMeshComplex_2InTriangulation_3` \sa `CGAL::Surface_mesh_complex_2_in_triangulation_3` \sa `CGAL::Surface_mesh_default_triangulation_3` -\sa `CGAL::make_surface_mesh` +\sa `CGAL::make_surface_mesh()` */ diff --git a/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshTraits_3.h b/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshTraits_3.h index 5f8af22333d..f4c906b699c 100644 --- a/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshTraits_3.h +++ b/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshTraits_3.h @@ -13,7 +13,7 @@ a small set of initial points on the surface. \cgalHasModel `CGAL::Surface_mesh_traits_generator_3::Type` -\sa `CGAL::make_surface_mesh` +\sa `CGAL::make_surface_mesh()` */ diff --git a/Surface_mesher/doc/Surface_mesher/Concepts/Surface_3.h b/Surface_mesher/doc/Surface_mesher/Concepts/Surface_3.h index d26b1c3b7de..cf6102d3db7 100644 --- a/Surface_mesher/doc/Surface_mesher/Concepts/Surface_3.h +++ b/Surface_mesher/doc/Surface_mesher/Concepts/Surface_3.h @@ -10,7 +10,7 @@ and assignable. \cgalHasModel `CGAL::Implicit_surface_3` -\sa `CGAL::make_surface_mesh` +\sa `CGAL::make_surface_mesh()` \sa `SurfaceMeshTraits_3` \sa `CGAL::Surface_mesh_traits_generator_3`