add relates

2023-02-07 13:10:14 +01:00 · 2023-02-07 13:10:14 +01:00 · 0e8bc6a7dd
parent 9242a810c4
commit 0e8bc6a7dd
12 changed files with 26 additions and 2 deletions
--- a/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/K_neighbor_query.h
+++ b/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/K_neighbor_query.h
@ -217,6 +217,7 @@ namespace Point_set {
      \ingroup PkgShapeDetectionRGOnPointSet3
      shortcut to ease the definition of the class when using `CGAL::Point_set_3`.
      To be used together with `make_k_neighbor_query()`.
+      \relates K_neighbor_query
   */
  template <class PointSet3>
  using K_neighbor_query_for_point_set =
@ -227,6 +228,7 @@ namespace Point_set {
  /*!
      \ingroup PkgShapeDetectionRGOnPointSet3
      returns an instance of the sorting class to be used with `CGAL::Point_set_3`, with point and normal maps added to `np`.
+      \relates K_neighbor_query
   */
  template <class PointSet3, typename CGAL_NP_TEMPLATE_PARAMETERS>
  K_neighbor_query_for_point_set<PointSet3>
--- a/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_circle_fit_region.h
+++ b/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_circle_fit_region.h
@ -383,6 +383,7 @@ namespace Point_set {
      \ingroup PkgShapeDetectionRGOnPointSet3
      shortcut to ease the definition of the class when using `CGAL::Point_set_3`.
      To be used together with `make_least_squares_sphere_fit_sorting()`.
+      \relates Least_squares_circle_fit_region
   */
  template <class PointSet3>
  using Least_squares_circle_fit_region_for_point_set =
@ -394,6 +395,7 @@ namespace Point_set {
  /*!
      \ingroup PkgShapeDetectionRGOnPointSet3
      returns an instance of the sorting class to be used with `CGAL::Point_set_3`, with point and normal maps added to `np`.
+      \relates Least_squares_circle_fit_region
   */
  template <class PointSet3, typename CGAL_NP_TEMPLATE_PARAMETERS>
  Least_squares_circle_fit_region_for_point_set<PointSet3>
--- a/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_circle_fit_sorting.h
+++ b/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_circle_fit_sorting.h
@ -214,6 +214,7 @@ namespace Point_set {
      \ingroup PkgShapeDetectionRGOnPointSet3
      shortcut to ease the definition of the class when using `CGAL::Point_set_3`.
      To be used together with `make_least_squares_circle_fit_sorting()`.
+      \relates Least_squares_circle_fit_sorting
   */
  template <class PointSet3, class NeighborQuery>
  using Least_squares_circle_fit_sorting_for_point_set =
@ -225,6 +226,7 @@ namespace Point_set {
  /*!
      \ingroup PkgShapeDetectionRGOnPointSet3
      returns an instance of the sorting class to be used with `CGAL::Point_set_3`, with point and normal maps added to `np`.
+      \relates Least_squares_circle_fit_sorting
   */
  template <class PointSet3, class NeighborQuery,typename CGAL_NP_TEMPLATE_PARAMETERS>
  Least_squares_circle_fit_sorting_for_point_set<PointSet3, NeighborQuery>
--- a/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_cylinder_fit_region.h
+++ b/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_cylinder_fit_region.h
@ -390,6 +390,7 @@ namespace Point_set {
      \ingroup PkgShapeDetectionRGOnPointSet3
      shortcut to ease the definition of the class when using `CGAL::Point_set_3`.
      To be used together with `make_least_squares_cylinder_fit_region()`.
+      \relates Least_squares_cylinder_fit_region
   */
  template <class PointSet3>
  using Least_squares_cylinder_fit_region_for_point_set =
@ -401,6 +402,7 @@ namespace Point_set {
  /*!
      \ingroup PkgShapeDetectionRGOnPointSet3
      returns an instance of the sorting class to be used with `CGAL::Point_set_3`, with point and normal maps added to `np`.
+      \relates Least_squares_cylinder_fit_region
   */
  template <class PointSet3, typename CGAL_NP_TEMPLATE_PARAMETERS>
  Least_squares_cylinder_fit_region_for_point_set<PointSet3>
--- a/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_cylinder_fit_sorting.h
+++ b/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_cylinder_fit_sorting.h
@ -223,6 +223,7 @@ namespace Point_set {
      \ingroup PkgShapeDetectionRGOnPointSet3
      shortcut to ease the definition of the class when using `CGAL::Point_set_3`.
      To be used together with `make_least_squares_cylinder_fit_sorting()`.
+      \relates Least_squares_cylinder_fit_sorting
   */
  template <class PointSet3, class NeighborQuery>
  using Least_squares_cylinder_fit_sorting_for_point_set =
@ -235,6 +236,7 @@ namespace Point_set {
  /*!
      \ingroup PkgShapeDetectionRGOnPointSet3
      returns an instance of the sorting class to be used with `CGAL::Point_set_3`, with point and normal maps added to `np`.
+      \relates Least_squares_cylinder_fit_sorting
   */
  template <class PointSet3, class NeighborQuery, typename CGAL_NP_TEMPLATE_PARAMETERS>
  Least_squares_cylinder_fit_sorting_for_point_set<PointSet3,NeighborQuery>
--- a/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_line_fit_region.h
+++ b/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_line_fit_region.h
@ -365,6 +365,7 @@ namespace Point_set {
      \ingroup PkgShapeDetectionRGOnPointSet3
      shortcut to ease the definition of the class when using `CGAL::Point_set_3`.
      To be used together with `make_least_squares_line_fit_region()`.
+      \relates Least_squares_line_fit_region
   */
  template <class PointSet3>
  using Least_squares_line_fit_region_for_point_set =
@ -376,6 +377,7 @@ namespace Point_set {
  /*!
      \ingroup PkgShapeDetectionRGOnPointSet3
      returns an instance of the sorting class to be used with `CGAL::Point_set_3`, with point and normal maps added to `np`.
+      \relates Least_squares_line_fit_region
  */
  template <class PointSet3, typename CGAL_NP_TEMPLATE_PARAMETERS>
  Least_squares_line_fit_region_for_point_set<PointSet3>
--- a/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_line_fit_sorting.h
+++ b/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_line_fit_sorting.h
@ -202,6 +202,7 @@ namespace Point_set {
      \ingroup PkgShapeDetectionRGOnPointSet3
      shortcut to ease the definition of the class when using `CGAL::Point_set_3`.
      To be used together with `make_least_squares_line_fit_sorting()`.
+      \relates Least_squares_line_fit_sorting
   */
  template <class PointSet3, class NeighborQuery>
  using Least_squares_line_fit_sorting_for_point_set =
@ -213,6 +214,7 @@ namespace Point_set {
  /*!
      \ingroup PkgShapeDetectionRGOnPointSet3
      returns an instance of the sorting class to be used with `CGAL::Point_set_3`, with point and normal maps added to `np`.
+      \relates Least_squares_line_fit_sorting
  */
  template <class PointSet3, class NeighborQuery, typename CGAL_NP_TEMPLATE_PARAMETERS>
  Least_squares_line_fit_sorting_for_point_set<PointSet3,NeighborQuery>
--- a/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_plane_fit_region.h
+++ b/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_plane_fit_region.h
@ -366,6 +366,7 @@ namespace Point_set {
  \ingroup PkgShapeDetectionRGOnPointSet3
  shortcut to ease the definition of the class when using `CGAL::Point_set_3`.
  To be used together with `make_least_squares_plane_fit_region()`.
+  \relates Least_squares_plane_fit_region
 */
 template <class PointSet3>
 using Least_squares_plane_fit_region_for_point_set =
@ -377,6 +378,7 @@ using Least_squares_plane_fit_region_for_point_set =
 /*!
  \ingroup PkgShapeDetectionRGOnPointSet3
  returns an instance of the sorting class to be used with `CGAL::Point_set_3`, with point and normal maps added to `np`.
+  \relates Least_squares_plane_fit_region
 */
 template <class PointSet3, typename CGAL_NP_TEMPLATE_PARAMETERS>
 Least_squares_plane_fit_region_for_point_set<PointSet3>
--- a/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_plane_fit_sorting.h
+++ b/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_plane_fit_sorting.h
@ -203,6 +203,7 @@ namespace Point_set {
  \ingroup PkgShapeDetectionRGOnPointSet3
  shortcut to ease the definition of the class when using `CGAL::Point_set_3`.
  To be used together with `make_least_squares_plane_fit_sorting()`.
+  \relates Least_squares_plane_fit_sorting
 */
 template <class PointSet3, class NeighborQuery>
 using Least_squares_plane_fit_sorting_for_point_set =
@ -214,6 +215,7 @@ using Least_squares_plane_fit_sorting_for_point_set =
 /*!
  \ingroup PkgShapeDetectionRGOnPointSet3
  returns an instance of the sorting class to be used with `CGAL::Point_set_3`, with point and normal maps added to `np`.
+  \relates Least_squares_plane_fit_sorting
 */
 template <class PointSet3, class NeighborQuery, typename CGAL_NP_TEMPLATE_PARAMETERS>
 Least_squares_plane_fit_sorting_for_point_set<PointSet3,NeighborQuery>
--- a/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_sphere_fit_region.h
+++ b/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_sphere_fit_region.h
@ -372,6 +372,7 @@ namespace Point_set {
  \ingroup PkgShapeDetectionRGOnPointSet3
  shortcut to ease the definition of the class when using `CGAL::Point_set_3`.
  To be used together with `make_least_squares_sphere_fit_region()`.
+  \relates Least_squares_sphere_fit_region
 */
 template <class PointSet3>
 using Least_squares_sphere_fit_region_for_point_set =
@ -383,6 +384,7 @@ using Least_squares_sphere_fit_region_for_point_set =
 /*!
  \ingroup PkgShapeDetectionRGOnPointSet3
  returns an instance of the sorting class to be used with `CGAL::Point_set_3`, with point and normal maps added to `np`.
+  \relates Least_squares_sphere_fit_region
 */
 template <class PointSet3, typename CGAL_NP_TEMPLATE_PARAMETERS>
 Least_squares_sphere_fit_region_for_point_set<PointSet3>
--- a/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_sphere_fit_sorting.h
+++ b/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_sphere_fit_sorting.h
@ -213,6 +213,7 @@ namespace Point_set {
  \ingroup PkgShapeDetectionRGOnPointSet3
  shortcut to ease the definition of the class when using `CGAL::Point_set_3`.
  To be used together with `make_least_squares_sphere_fit_sorting()`.
+  \relates Least_squares_sphere_fit_sorting
 */
 template <class PointSet3, class NeighborQuery>
 using Least_squares_sphere_fit_sorting_for_point_set =
@ -224,6 +225,7 @@ using Least_squares_sphere_fit_sorting_for_point_set =
 /*!
  \ingroup PkgShapeDetectionRGOnPointSet3
  returns an instance of the sorting class to be used with `CGAL::Point_set_3`, with point and normal maps added to `np`.
+  \relates Least_squares_sphere_fit_sorting
 */
 template <class PointSet3, class NeighborQuery, typename CGAL_NP_TEMPLATE_PARAMETERS>
 Least_squares_sphere_fit_sorting_for_point_set<PointSet3,NeighborQuery>
--- a/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Sphere_neighbor_query.h
+++ b/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Sphere_neighbor_query.h
@ -215,6 +215,7 @@ private:
  \ingroup PkgShapeDetectionRGOnPointSet3
  shortcut to ease the definition of the class when using `CGAL::Point_set_3`.
  To be used together with `make_sphere_neighbor_query()`.
+  \relates Sphere_neighbor_query
 */
 template <class PointSet3>
 using Sphere_neighbor_query_for_point_set =
@ -225,6 +226,7 @@ using Sphere_neighbor_query_for_point_set =
 /*!
  \ingroup PkgShapeDetectionRGOnPointSet3
  returns an instance of the sorting class to be used with `CGAL::Point_set_3`, with point and normal maps added to `np`.
+  \relates Sphere_neighbor_query
 */
 template <class PointSet3, typename CGAL_NP_TEMPLATE_PARAMETERS>
 Sphere_neighbor_query_for_point_set<PointSet3>