From a2e8a1c68fa225659d798d339683000dfd7ad059 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Loriot?= Date: Tue, 4 Sep 2018 11:11:41 +0200 Subject: [PATCH] add the suffix Ref to doxygen link to reference --- .../doc/AABB_tree/PackageDescription.txt | 8 ++-- .../CGAL/AABB_face_graph_triangle_primitive.h | 2 +- .../AABB_halfedge_graph_segment_primitive.h | 2 +- .../CGAL/AABB_polyhedron_segment_primitive.h | 2 +- .../CGAL/AABB_polyhedron_triangle_primitive.h | 2 +- AABB_tree/include/CGAL/AABB_primitive.h | 2 +- .../include/CGAL/AABB_segment_primitive.h | 2 +- AABB_tree/include/CGAL/AABB_traits.h | 2 +- AABB_tree/include/CGAL/AABB_tree.h | 2 +- .../include/CGAL/AABB_triangle_primitive.h | 2 +- .../AABB_triangulation_3_triangle_primitive.h | 2 +- .../PackageDescription.txt | 6 +-- .../Advancing_front_surface_reconstruction.h | 6 +-- ...front_surface_reconstruction_cell_base_3.h | 2 +- ...ont_surface_reconstruction_vertex_base_3.h | 2 +- .../Algebraic_foundations.txt | 2 +- .../CGAL/Algebraic_structure_traits.h | 18 ++++---- .../CGAL/Coercion_traits.h | 2 +- .../CGAL/Fraction_traits.h | 2 +- .../CGAL/Real_embeddable_traits.h | 2 +- .../Algebraic_foundations/CGAL/number_utils.h | 46 +++++++++---------- .../PackageDescription.txt | 8 ++-- .../Algebraic_kernel_d/PackageDescription.txt | 10 ++-- .../doc/Alpha_shapes_2/CGAL/Alpha_shape_2.h | 2 +- .../CGAL/Alpha_shape_face_base_2.h | 2 +- .../CGAL/Alpha_shape_vertex_base_2.h | 2 +- .../Weighted_alpha_shape_euclidean_traits_2.h | 2 +- .../doc/Alpha_shapes_2/PackageDescription.txt | 8 ++-- .../doc/Alpha_shapes_3/CGAL/Alpha_shape_3.h | 2 +- .../CGAL/Alpha_shape_cell_base_3.h | 4 +- .../CGAL/Alpha_shape_vertex_base_3.h | 2 +- .../Alpha_shapes_3/CGAL/Fixed_alpha_shape_3.h | 2 +- .../CGAL/Fixed_alpha_shape_cell_base_3.h | 2 +- .../CGAL/Fixed_alpha_shape_vertex_base_3.h | 2 +- .../doc/Alpha_shapes_3/PackageDescription.txt | 8 ++-- .../CGAL/Apollonius_graph_2.h | 2 +- .../CGAL/Apollonius_graph_filtered_traits_2.h | 2 +- .../CGAL/Apollonius_graph_hierarchy_2.h | 2 +- ...Apollonius_graph_hierarchy_vertex_base_2.h | 2 +- .../CGAL/Apollonius_graph_traits_2.h | 2 +- .../CGAL/Apollonius_graph_vertex_base_2.h | 2 +- .../CGAL/Apollonius_site_2.h | 2 +- .../Apollonius_graph_2/PackageDescription.txt | 8 ++-- .../CGAL/Arr_accessor.h | 2 +- .../CGAL/Arr_face_index_map.h | 2 +- .../CGAL/Arr_observer.h | 2 +- .../CGAL/Arr_vertex_index_map.h | 2 +- .../CGAL/Arrangement_2.h | 2 +- .../CGAL/Arrangement_with_history_2.h | 2 +- .../PackageDescription.txt | 26 +++++------ BGL/doc/BGL/NamedParameters.txt | 2 +- BGL/doc/BGL/PackageDescription.txt | 28 +++++------ BGL/doc/BGL/graph_traits.txt | 2 +- BGL/include/CGAL/boost/graph/partition.h | 2 +- .../boost/graph/split_graph_into_polylines.h | 2 +- .../Barycentric_coordinates_2.txt | 2 +- .../PackageDescription.txt | 8 ++-- .../Discrete_harmonic_2.h | 2 +- .../Generalized_barycentric_coordinates_2.h | 2 +- .../Barycentric_coordinates_2/Mean_value_2.h | 2 +- .../Segment_coordinates_2.h | 2 +- .../Triangle_coordinates_2.h | 2 +- .../Barycentric_coordinates_2/Wachspress_2.h | 2 +- .../barycentric_enum_2.h | 2 +- .../CGAL/Boolean_set_operations_2.h | 14 +++--- .../Gps_default_dcel.h | 6 +-- .../CGAL/General_polygon_2.h | 2 +- .../CGAL/General_polygon_set_2.h | 2 +- .../CGAL/Gps_circle_segment_traits_2.h | 2 +- .../CGAL/Gps_segment_traits_2.h | 2 +- .../CGAL/Gps_traits_2.h | 2 +- .../CGAL/Polygon_set_2.h | 2 +- .../CGAL/connect_holes.h | 2 +- .../PackageDescription.txt | 8 ++-- .../CGAL/Approximate_min_ellipsoid_d.h | 2 +- .../Approximate_min_ellipsoid_d_traits_2.h | 2 +- .../Approximate_min_ellipsoid_d_traits_3.h | 2 +- .../Approximate_min_ellipsoid_d_traits_d.h | 2 +- .../doc/Bounding_volumes/CGAL/Min_annulus_d.h | 2 +- .../doc/Bounding_volumes/CGAL/Min_circle_2.h | 2 +- .../CGAL/Min_circle_2_traits_2.h | 2 +- .../doc/Bounding_volumes/CGAL/Min_ellipse_2.h | 2 +- .../CGAL/Min_ellipse_2_traits_2.h | 2 +- .../CGAL/Min_quadrilateral_traits_2.h | 2 +- .../CGAL/Min_sphere_annulus_d_traits_2.h | 2 +- .../CGAL/Min_sphere_annulus_d_traits_3.h | 2 +- .../CGAL/Min_sphere_annulus_d_traits_d.h | 2 +- .../doc/Bounding_volumes/CGAL/Min_sphere_d.h | 2 +- .../CGAL/Min_sphere_of_points_d_traits_2.h | 2 +- .../CGAL/Min_sphere_of_points_d_traits_3.h | 2 +- .../CGAL/Min_sphere_of_points_d_traits_d.h | 2 +- .../CGAL/Min_sphere_of_spheres_d.h | 2 +- .../CGAL/Min_sphere_of_spheres_d_traits_2.h | 2 +- .../CGAL/Min_sphere_of_spheres_d_traits_3.h | 2 +- .../CGAL/Min_sphere_of_spheres_d_traits_d.h | 2 +- .../CGAL/min_quadrilateral_2.h | 6 +-- .../CGAL/rectangular_p_center_2.h | 4 +- .../Bounding_volumes/PackageDescription.txt | 8 ++-- .../Box_intersection_d/PackageDescription.txt | 18 ++++---- .../doc/CGAL_ipelets/CGAL/CGAL_Ipelet_base.h | 4 +- .../doc/CGAL_ipelets/PackageDescription.txt | 6 +-- .../Circular_kernel_2/PackageDescription.txt | 16 +++---- .../Circular_kernel_3/PackageDescription.txt | 16 +++---- Circulator/doc/Circulator/CGAL/circulator.h | 2 +- .../doc/Circulator/PackageDescription.txt | 18 ++++---- .../doc/Classification/PackageDescription.txt | 26 +++++------ .../Combinatorial_map/PackageDescription.txt | 14 +++--- .../Cone_spanners_2/PackageDescription.txt | 6 +-- .../include/CGAL/Compute_cone_boundaries_2.h | 2 +- .../include/CGAL/Cone_spanners_enum_2.h | 2 +- .../include/CGAL/Construct_theta_graph_2.h | 2 +- .../include/CGAL/Construct_yao_graph_2.h | 2 +- .../include/CGAL/gnuplot_output_2.h | 2 +- .../PackageDescription.txt | 6 +-- .../include/CGAL/convex_decomposition_3.h | 2 +- .../doc/Convex_hull_2/PackageDescription.txt | 18 ++++---- .../doc/Convex_hull_3/PackageDescription.txt | 14 +++--- .../doc/Convex_hull_d/CGAL/Convex_hull_d.h | 2 +- .../CGAL/Convex_hull_d_traits_3.h | 2 +- .../doc/Convex_hull_d/CGAL/Delaunay_d.h | 2 +- .../doc/Convex_hull_d/PackageDescription.txt | 8 ++-- .../doc/Documentation/Installation.txt | 20 ++++---- .../doc/Envelope_2/CGAL/Envelope_diagram_1.h | 2 +- Envelope_2/doc/Envelope_2/CGAL/envelope_2.h | 8 ++-- .../doc/Envelope_2/PackageDescription.txt | 8 ++-- .../doc/Envelope_3/CGAL/Env_plane_traits_3.h | 2 +- .../doc/Envelope_3/CGAL/Env_sphere_traits_3.h | 2 +- .../CGAL/Env_surface_data_traits_3.h | 2 +- .../Envelope_3/CGAL/Env_triangle_traits_3.h | 2 +- Envelope_3/doc/Envelope_3/CGAL/envelope_3.h | 10 ++-- .../doc/Envelope_3/PackageDescription.txt | 8 ++-- .../Generalized_map/PackageDescription.txt | 10 ++-- .../Generator/CGAL/Combination_enumerator.h | 2 +- Generator/doc/Generator/CGAL/Random.h | 6 +-- .../doc/Generator/CGAL/point_generators_2.h | 2 +- .../doc/Generator/CGAL/point_generators_3.h | 2 +- .../doc/Generator/CGAL/point_generators_d.h | 2 +- .../CGAL/random_convex_hull_in_disc_2.h | 2 +- .../doc/Generator/CGAL/random_convex_set_2.h | 2 +- .../doc/Generator/CGAL/random_polygon_2.h | 2 +- .../doc/Generator/CGAL/random_selection.h | 2 +- .../doc/Generator/PackageDescription.txt | 8 ++-- .../doc/Geomview/CGAL/IO/Geomview_stream.h | 8 ++-- Geomview/doc/Geomview/PackageDescription.txt | 6 +-- .../doc/GraphicsView/PackageDescription.txt | 12 ++--- .../doc/HalfedgeDS/PackageDescription.txt | 16 +++---- .../CGAL/Extremal_polygon_traits_2.h | 4 +- .../CGAL/Largest_empty_iso_rectangle_2.h | 2 +- .../Inscribed_areas/CGAL/extremal_polygon_2.h | 6 +-- .../Inscribed_areas/PackageDescription.txt | 8 ++-- .../CGAL/interpolation_functions.h | 2 +- .../doc/Interpolation/PackageDescription.txt | 14 +++--- .../CGAL/Interval_skip_list.h | 2 +- .../CGAL/Interval_skip_list_interval.h | 2 +- .../Interval_skip_list/CGAL/Level_interval.h | 2 +- .../Interval_skip_list/PackageDescription.txt | 8 ++-- .../CGAL/Monge_via_jet_fitting.h | 4 +- .../doc/Jet_fitting_3/PackageDescription.txt | 8 ++-- Kernel_23/doc/Kernel_23/CGAL/Origin.h | 4 +- .../doc/Kernel_23/PackageDescription.txt | 24 +++++----- Kernel_d/doc/Kernel_d/PackageDescription.txt | 18 ++++---- .../PackageDescription.txt | 16 +++---- .../doc/Matrix_search/CGAL/Dynamic_matrix.h | 2 +- .../Sorted_matrix_search_traits_adaptor.h | 2 +- .../CGAL/monotone_matrix_search.h | 2 +- .../Matrix_search/CGAL/sorted_matrix_search.h | 2 +- .../doc/Matrix_search/PackageDescription.txt | 8 ++-- .../Mesh_2/CGAL/Delaunay_mesh_criteria_2.h | 2 +- .../Mesh_2/CGAL/Delaunay_mesh_face_base_2.h | 2 +- .../CGAL/Delaunay_mesh_size_criteria_2.h | 2 +- .../Mesh_2/CGAL/Delaunay_mesh_vertex_base_2.h | 2 +- Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesher_2.h | 2 +- Mesh_2/doc/Mesh_2/CGAL/Mesh_2/Face_badness.h | 2 +- .../Mesh_2/CGAL/Triangulation_conformer_2.h | 2 +- Mesh_2/doc/Mesh_2/PackageDescription.txt | 12 ++--- Mesh_3/doc/Mesh_3/PackageDescription.txt | 22 ++++----- .../CGAL/Polygon_convex_decomposition_2.h | 4 +- .../CGAL/Polygon_nop_decomposition_2.h | 2 +- .../Polygon_triangulation_decomposition_2.h | 2 +- .../CGAL/Polygon_vertical_decomposition_2.h | 2 +- ...mall_side_angle_bisector_decomposition_2.h | 2 +- .../CGAL/approximated_offset_2.h | 8 ++-- .../Minkowski_sum_2/CGAL/minkowski_sum_2.h | 12 ++--- .../Minkowski_sum_2/CGAL/offset_polygon_2.h | 8 ++-- .../Minkowski_sum_2/PackageDescription.txt | 8 ++-- .../Minkowski_sum_2/AABB_tree_with_join.h | 2 +- .../Minkowski_sum_3/PackageDescription.txt | 6 +-- .../include/CGAL/minkowski_sum_3.h | 2 +- .../Miscellany/CGAL/Handle_hash_function.h | 2 +- Miscellany/doc/Miscellany/CGAL/Memory_sizer.h | 2 +- .../doc/Miscellany/CGAL/Modifier_base.h | 2 +- .../doc/Miscellany/CGAL/Profile_counter.h | 2 +- Miscellany/doc/Miscellany/CGAL/Real_timer.h | 2 +- Miscellany/doc/Miscellany/CGAL/Timer.h | 2 +- Miscellany/doc/Miscellany/CGAL/Union_find.h | 2 +- .../doc/Miscellany/CGAL/Unique_hash_map.h | 2 +- .../doc/Miscellany/PackageDescription.txt | 8 ++-- .../Modular_arithmetic/CGAL/Modular_traits.h | 2 +- .../doc/Modular_arithmetic/CGAL/Residue.h | 2 +- .../Modular_arithmetic/PackageDescription.txt | 8 ++-- Nef_2/doc/Nef_2/CGAL/Extended_cartesian.h | 2 +- Nef_2/doc/Nef_2/CGAL/Extended_homogeneous.h | 2 +- .../CGAL/Filtered_extended_homogeneous.h | 2 +- Nef_2/doc/Nef_2/CGAL/Nef_polyhedron_2.h | 6 +-- Nef_2/doc/Nef_2/PackageDescription.txt | 8 ++-- Nef_3/doc/Nef_3/CGAL/Nef_nary_union_3.h | 2 +- Nef_3/doc/Nef_3/CGAL/Nef_polyhedron_3.h | 20 ++++---- Nef_3/doc/Nef_3/PackageDescription.txt | 8 ++-- Nef_S2/doc/Nef_S2/CGAL/Nef_polyhedron_S2.h | 18 ++++---- Nef_S2/doc/Nef_S2/PackageDescription.txt | 6 +-- .../Number_types/CGAL/number_type_config.h | 2 +- .../doc/Number_types/NumberTypeSupport.txt | 2 +- .../doc/Number_types/PackageDescription.txt | 26 +++++------ .../PackageDescription.txt | 10 ++-- .../CGAL/Partition_is_valid_traits_2.h | 2 +- .../doc/Partition_2/CGAL/Partition_traits_2.h | 2 +- .../doc/Partition_2/CGAL/is_y_monotone_2.h | 2 +- .../doc/Partition_2/CGAL/partition_2.h | 8 ++-- .../Partition_2/CGAL/partition_is_valid_2.h | 6 +-- .../doc/Partition_2/PackageDescription.txt | 12 ++--- .../Periodic_2TriangulationTraits_2.h | 2 +- .../PackageDescription.txt | 16 +++---- .../Periodic_3_mesh_3/PackageDescription.txt | 16 +++---- .../PackageDescription.txt | 12 ++--- .../doc/Point_set_2/CGAL/Point_set_2.h | 2 +- .../doc/Point_set_2/PackageDescription.txt | 12 ++--- .../doc/Point_set_3/PackageDescription.txt | 8 ++-- Point_set_3/doc/Point_set_3/Point_set_3.txt | 2 +- Point_set_3/include/CGAL/Point_set_3.h | 4 +- .../NamedParameters.txt | 2 +- .../PackageDescription.txt | 14 +++--- .../Point_set_processing_3.txt | 4 +- .../PackageDescription.txt | 10 ++-- .../include/CGAL/Shape_detection_3.h | 2 +- .../CGAL/Shape_detection_3/Efficient_RANSAC.h | 2 +- .../Efficient_RANSAC_traits.h | 2 +- .../CGAL/Shape_detection_3/Region_growing.h | 2 +- .../Shape_detection_traits.h | 2 +- .../CGAL/Shape_detection_3/property_maps.h | 4 +- .../include/CGAL/regularize_planes.h | 4 +- .../PackageDescription.txt | 6 +-- .../CGAL/Poisson_reconstruction_function.h | 2 +- .../CGAL/poisson_surface_reconstruction.h | 2 +- Polygon/doc/Polygon/PackageDescription.txt | 10 ++-- .../CGAL/General_polygon_with_holes_2.h | 2 +- Polygon/include/CGAL/Polygon_2.h | 2 +- Polygon/include/CGAL/Polygon_with_holes_2.h | 2 +- .../NamedParameters.txt | 2 +- .../PackageDescription.txt | 32 ++++++------- .../CGAL/Polygon_mesh_processing/bbox.h | 10 ++-- .../CGAL/Polygon_mesh_processing/border.h | 2 +- .../CGAL/Polygon_mesh_processing/transform.h | 2 +- .../include/CGAL/Polygon_mesh_slicer.h | 2 +- .../include/CGAL/Side_of_triangle_mesh.h | 2 +- .../include/CGAL/polygon_mesh_processing.h | 2 +- Polyhedron/doc/Polyhedron/CGAL/Polyhedron_3.h | 8 ++-- .../CGAL/Polyhedron_incremental_builder_3.h | 2 +- .../doc/Polyhedron/CGAL/Polyhedron_items_3.h | 2 +- .../Polyhedron/CGAL/Polyhedron_min_items_3.h | 2 +- .../doc/Polyhedron/CGAL/Polyhedron_traits_3.h | 2 +- .../CGAL/Polyhedron_traits_with_normals_3.h | 2 +- .../doc/Polyhedron/PackageDescription.txt | 12 ++--- .../PackageDescription.txt | 12 ++--- .../doc/Polynomial/PackageDescription.txt | 12 ++--- .../CGAL/Polytope_distance_d.h | 2 +- .../CGAL/Polytope_distance_d_traits_2.h | 2 +- .../CGAL/Polytope_distance_d_traits_3.h | 2 +- .../CGAL/Polytope_distance_d_traits_d.h | 2 +- .../doc/Polytope_distance_d/CGAL/Width_3.h | 2 +- .../CGAL/Width_default_traits_3.h | 2 +- .../CGAL/all_furthest_neighbors_2.h | 2 +- .../PackageDescription.txt | 8 ++-- .../PackageDescription.txt | 16 +++---- .../doc/Property_map/PackageDescription.txt | 6 +-- Property_map/include/CGAL/property_map.h | 32 ++++++------- .../doc/QP_solver/PackageDescription.txt | 12 ++--- Ridges_3/doc/Ridges_3/CGAL/Ridges.h | 10 ++-- Ridges_3/doc/Ridges_3/CGAL/Umbilics.h | 6 +-- Ridges_3/doc/Ridges_3/PackageDescription.txt | 8 ++-- .../doc/STL_Extension/CGAL/CC_safe_handle.h | 2 +- .../STL_Extension/CGAL/Compact_container.h | 2 +- .../CGAL/Concurrent_compact_container.h | 2 +- .../doc/STL_Extension/CGAL/Default.h | 2 +- .../doc/STL_Extension/CGAL/In_place_list.h | 2 +- .../doc/STL_Extension/CGAL/Iterator_range.h | 2 +- .../doc/STL_Extension/CGAL/Multiset.h | 2 +- STL_Extension/doc/STL_Extension/CGAL/Object.h | 2 +- .../STL_Extension/CGAL/Spatial_lock_grid_3.h | 2 +- .../doc/STL_Extension/CGAL/algorithm.h | 2 +- STL_Extension/doc/STL_Extension/CGAL/array.h | 2 +- .../doc/STL_Extension/CGAL/function.h | 2 +- .../doc/STL_Extension/CGAL/function_objects.h | 4 +- .../doc/STL_Extension/CGAL/iterator.h | 2 +- STL_Extension/doc/STL_Extension/CGAL/memory.h | 2 +- .../doc/STL_Extension/CGAL/result_of.h | 2 +- STL_Extension/doc/STL_Extension/CGAL/tuple.h | 2 +- .../doc/STL_Extension/PackageDescription.txt | 12 ++--- STL_Extension/include/CGAL/Iterator_range.h | 2 +- .../include/CGAL/value_type_traits.h | 2 +- .../PackageDescription.txt | 10 ++-- .../doc/SearchStructures/CGAL/Tree_base.h | 2 +- .../SearchStructures/PackageDescription.txt | 12 ++--- .../CGAL/Segment_Delaunay_graph_2.h | 2 +- ...Segment_Delaunay_graph_filtered_traits_2.h | 4 +- .../CGAL/Segment_Delaunay_graph_hierarchy_2.h | 2 +- ...t_Delaunay_graph_hierarchy_vertex_base_2.h | 2 +- .../CGAL/Segment_Delaunay_graph_site_2.h | 2 +- .../Segment_Delaunay_graph_storage_site_2.h | 2 +- .../CGAL/Segment_Delaunay_graph_traits_2.h | 4 +- .../Segment_Delaunay_graph_vertex_base_2.h | 2 +- .../PackageDescription.txt | 8 ++-- .../CGAL/Segment_Delaunay_graph_Linf_2.h | 2 +- ...nt_Delaunay_graph_Linf_filtered_traits_2.h | 4 +- .../Segment_Delaunay_graph_Linf_hierarchy_2.h | 2 +- .../Segment_Delaunay_graph_Linf_traits_2.h | 4 +- .../PackageDescription.txt | 8 ++-- .../PackageDescription.txt | 14 +++--- .../doc/Skin_surface_3/CGAL/Skin_surface_3.h | 2 +- .../CGAL/Skin_surface_polyhedral_items_3.h | 2 +- .../CGAL/Skin_surface_traits_3.h | 2 +- .../Skin_surface_3/CGAL/Union_of_balls_3.h | 2 +- .../CGAL/make_skin_surface_mesh_3.h | 2 +- .../Skin_surface_3/CGAL/mesh_skin_surface_3.h | 2 +- .../CGAL/subdivide_skin_surface_mesh_3.h | 2 +- .../doc/Skin_surface_3/PackageDescription.txt | 8 ++-- .../Snap_rounding_2/CGAL/Snap_rounding_2.h | 2 +- .../CGAL/Snap_rounding_traits_2.h | 2 +- .../Snap_rounding_2/PackageDescription.txt | 8 ++-- .../Solver_interface/PackageDescription.txt | 8 ++-- .../doc/Solver_interface/Solver_interface.txt | 4 +- .../include/CGAL/Default_diagonalize_traits.h | 2 +- .../include/CGAL/Diagonalize_traits.h | 2 +- .../include/CGAL/Eigen_diagonalize_traits.h | 2 +- Solver_interface/include/CGAL/Eigen_matrix.h | 6 +-- .../include/CGAL/Eigen_solver_traits.h | 2 +- Solver_interface/include/CGAL/Eigen_svd.h | 2 +- Solver_interface/include/CGAL/Eigen_vector.h | 2 +- Solver_interface/include/CGAL/Lapack_svd.h | 6 +-- .../Spatial_searching/PackageDescription.txt | 20 ++++---- .../Spatial_sorting/PackageDescription.txt | 16 +++---- .../PackageDescription.txt | 14 +++--- .../Stream_lines_2/CGAL/Euler_integrator_2.h | 2 +- .../doc/Stream_lines_2/CGAL/Regular_grid_2.h | 2 +- .../CGAL/Runge_kutta_integrator_2.h | 2 +- .../doc/Stream_lines_2/CGAL/Stream_lines_2.h | 2 +- .../Stream_lines_2/CGAL/Triangular_field_2.h | 2 +- .../doc/Stream_lines_2/PackageDescription.txt | 8 ++-- .../doc/Stream_support/CGAL/IO/Color.h | 2 +- .../Stream_support/CGAL/IO/Istream_iterator.h | 2 +- .../Stream_support/CGAL/IO/Ostream_iterator.h | 2 +- .../Stream_support/CGAL/IO/Verbose_ostream.h | 2 +- .../doc/Stream_support/CGAL/IO/io.h | 28 +++++------ .../doc/Stream_support/PackageDescription.txt | 8 ++-- .../Subdivision_method_3/NamedParameters.txt | 2 +- .../PackageDescription.txt | 10 ++-- .../subdivision_masks_3.h | 8 ++-- .../include/CGAL/subdivision_method_3.h | 2 +- .../PackageDescription.txt | 8 ++-- ...ormation_Eigen_closest_rotation_traits_3.h | 2 +- ...on_Eigen_polar_closest_rotation_traits_3.h | 2 +- .../include/CGAL/Surface_mesh_deformation.h | 4 +- .../PackageDescription.txt | 16 +++---- .../PackageDescription.txt | 8 ++-- .../include/CGAL/mesh_segmentation.h | 8 ++-- .../PackageDescription.txt | 10 ++-- .../include/CGAL/Surface_mesh_shortest_path.h | 2 +- .../Surface_mesh_shortest_path.h | 2 +- .../Edge_collapse_visitor_base.h | 2 +- .../Bounded_normal_change_placement.h | 2 +- .../Edge_collapse/Constrained_placement.h | 2 +- .../Count_ratio_stop_predicate.h | 2 +- .../Edge_collapse/Count_stop_predicate.h | 2 +- .../Policies/Edge_collapse/Edge_length_cost.h | 2 +- .../Edge_length_stop_predicate.h | 2 +- .../Policies/Edge_collapse/Edge_profile.h | 2 +- .../Edge_collapse/LindstromTurk_cost.h | 2 +- .../Edge_collapse/LindstromTurk_placement.h | 2 +- .../Edge_collapse/Midpoint_placement.h | 2 +- .../edge_collapse.h | 2 +- .../NamedParameters.txt | 2 +- .../PackageDescription.txt | 8 ++-- .../PackageDescription.txt | 8 ++-- .../Mean_curvature_flow_skeletonization.h | 2 +- .../extract_mean_curvature_flow_skeleton.h | 2 +- .../doc/Surface_mesher/PackageDescription.txt | 14 +++--- .../CGAL/Surface_sweep_2_algorithms.h | 12 ++--- .../Surface_sweep_2/PackageDescription.txt | 6 +-- .../CGAL/Triangulation_data_structure_2.h | 2 +- .../TDS_2/CGAL/Triangulation_ds_face_base_2.h | 2 +- .../CGAL/Triangulation_ds_vertex_base_2.h | 2 +- TDS_2/doc/TDS_2/PackageDescription.txt | 8 ++-- TDS_3/doc/TDS_3/PackageDescription.txt | 10 ++-- Three/doc/Three/PackageDescription.txt | 6 +-- Three/include/CGAL/Three/Scene_interface.h | 2 +- .../doc/Triangulation/PackageDescription.txt | 14 +++--- .../Triangulation_2/PackageDescription.txt | 20 ++++---- .../Triangulation_3/CGAL/link_to_face_graph.h | 2 +- .../Triangulation_3/PackageDescription.txt | 16 +++---- .../doc/Visibility_2/PackageDescription.txt | 10 ++-- .../CGAL/Identity_policy_2.h | 2 +- .../CGAL/Voronoi_diagram_2.h | 8 ++-- .../Voronoi_diagram_2/PackageDescription.txt | 14 +++--- 402 files changed, 1063 insertions(+), 1063 deletions(-) diff --git a/AABB_tree/doc/AABB_tree/PackageDescription.txt b/AABB_tree/doc/AABB_tree/PackageDescription.txt index e94a561f00a..d629e984b36 100644 --- a/AABB_tree/doc/AABB_tree/PackageDescription.txt +++ b/AABB_tree/doc/AABB_tree/PackageDescription.txt @@ -1,16 +1,16 @@ -/// \defgroup PkgAABB_tree AABB Tree Reference +/// \defgroup PkgAABB_treeRef AABB Tree Reference /// \defgroup PkgAABB_treeConcepts Concepts -/// \ingroup PkgAABB_tree +/// \ingroup PkgAABB_treeRef /*! -\addtogroup PkgAABB_tree +\addtogroup PkgAABB_treeRef \cgalPkgDescriptionBegin{3D Fast Intersection and Distance Computation,PkgAABB_treeSummary} \cgalPkgPicture{aabb-teaser-thumb.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Pierre Alliez, Stéphane Tayeb, Camille Wormser} \cgalPkgDesc{The AABB (axis-aligned bounding box) tree component offers a static data structure and algorithms to perform efficient intersection and distance queries on sets of finite 3D geometric objects.} -\cgalPkgManuals{Chapter_3D_Fast_Intersection_and_Distance_Computation,PkgAABB_tree} +\cgalPkgManuals{Chapter_3D_Fast_Intersection_and_Distance_Computation,PkgAABB_treeRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.5} diff --git a/AABB_tree/include/CGAL/AABB_face_graph_triangle_primitive.h b/AABB_tree/include/CGAL/AABB_face_graph_triangle_primitive.h index 83e01c72d6c..c5a2ce6fae2 100644 --- a/AABB_tree/include/CGAL/AABB_face_graph_triangle_primitive.h +++ b/AABB_tree/include/CGAL/AABB_face_graph_triangle_primitive.h @@ -34,7 +34,7 @@ namespace CGAL { /*! - * \ingroup PkgAABB_tree + * \ingroup PkgAABB_treeRef * Primitive type for a facet of a polyhedral surface. * It wraps a handle to a facet of a polyhedron to a 3D triangle. * The polyhedron from which the primitive is built should not be deleted diff --git a/AABB_tree/include/CGAL/AABB_halfedge_graph_segment_primitive.h b/AABB_tree/include/CGAL/AABB_halfedge_graph_segment_primitive.h index 1a0dc4eb616..5f64ce6ea49 100644 --- a/AABB_tree/include/CGAL/AABB_halfedge_graph_segment_primitive.h +++ b/AABB_tree/include/CGAL/AABB_halfedge_graph_segment_primitive.h @@ -42,7 +42,7 @@ namespace CGAL { /*! - * \ingroup PkgAABB_tree + * \ingroup PkgAABB_treeRef * Primitive type for a edge of a polyhedral surface. * It wraps an `edge_descriptor` into a 3D segment. * The class model of `HalfedgeGraph` from which the primitive is built should not be deleted diff --git a/AABB_tree/include/CGAL/AABB_polyhedron_segment_primitive.h b/AABB_tree/include/CGAL/AABB_polyhedron_segment_primitive.h index 85798d83374..dc407931a24 100644 --- a/AABB_tree/include/CGAL/AABB_polyhedron_segment_primitive.h +++ b/AABB_tree/include/CGAL/AABB_polyhedron_segment_primitive.h @@ -40,7 +40,7 @@ namespace CGAL { -/// \addtogroup PkgAABB_tree +/// \addtogroup PkgAABB_treeRef /// @{ /// \deprecated This class is deprecated since \cgal 4.3, the class /// `AABB_halfedge_graph_segment_primitive` should be used instead. diff --git a/AABB_tree/include/CGAL/AABB_polyhedron_triangle_primitive.h b/AABB_tree/include/CGAL/AABB_polyhedron_triangle_primitive.h index 363a718c03f..12c632640f9 100644 --- a/AABB_tree/include/CGAL/AABB_polyhedron_triangle_primitive.h +++ b/AABB_tree/include/CGAL/AABB_polyhedron_triangle_primitive.h @@ -35,7 +35,7 @@ #include namespace CGAL { - /// \ingroup PkgAABB_tree + /// \ingroup PkgAABB_treeRef /// \deprecated This class is deprecated since \cgal 4.3, the class /// `AABB_face_graph_triangle_primitive` should be used instead. /// diff --git a/AABB_tree/include/CGAL/AABB_primitive.h b/AABB_tree/include/CGAL/AABB_primitive.h index 205dad36754..29cb908e32f 100644 --- a/AABB_tree/include/CGAL/AABB_primitive.h +++ b/AABB_tree/include/CGAL/AABB_primitive.h @@ -57,7 +57,7 @@ public: #ifdef DOXYGEN_RUNNING /*! - * \ingroup PkgAABB_tree + * \ingroup PkgAABB_treeRef * Generic primitive type. * The two property maps which are template parameters of the class enable to get the datum and the reference point of * the primitive from the identifier. The last template parameter controls whether the primitive class holds a copy of the datum. diff --git a/AABB_tree/include/CGAL/AABB_segment_primitive.h b/AABB_tree/include/CGAL/AABB_segment_primitive.h index 00618eafd34..2e9e483be53 100644 --- a/AABB_tree/include/CGAL/AABB_segment_primitive.h +++ b/AABB_tree/include/CGAL/AABB_segment_primitive.h @@ -56,7 +56,7 @@ namespace internal { /*! - * \ingroup PkgAABB_tree + * \ingroup PkgAABB_treeRef * Primitive type that uses as identifier an iterator with a 3D segment as `value_type`. * The iterator from which the primitive is built should not be invalided * while the AABB tree holding the primitive is in use. diff --git a/AABB_tree/include/CGAL/AABB_traits.h b/AABB_tree/include/CGAL/AABB_traits.h index 632f2256d4b..26a457c4fda 100644 --- a/AABB_tree/include/CGAL/AABB_traits.h +++ b/AABB_tree/include/CGAL/AABB_traits.h @@ -173,7 +173,7 @@ struct AABB_traits_base_2{ } } //end of namespace internal::AABB_tree -/// \addtogroup PkgAABB_tree +/// \addtogroup PkgAABB_treeRef /// @{ /// This traits class handles any type of 3D geometric diff --git a/AABB_tree/include/CGAL/AABB_tree.h b/AABB_tree/include/CGAL/AABB_tree.h index d4275852147..078f3be02ee 100644 --- a/AABB_tree/include/CGAL/AABB_tree.h +++ b/AABB_tree/include/CGAL/AABB_tree.h @@ -44,7 +44,7 @@ namespace CGAL { -/// \addtogroup PkgAABB_tree +/// \addtogroup PkgAABB_treeRef /// @{ /** diff --git a/AABB_tree/include/CGAL/AABB_triangle_primitive.h b/AABB_tree/include/CGAL/AABB_triangle_primitive.h index 4b2035e00f4..694d937830c 100644 --- a/AABB_tree/include/CGAL/AABB_triangle_primitive.h +++ b/AABB_tree/include/CGAL/AABB_triangle_primitive.h @@ -56,7 +56,7 @@ namespace internal { /*! - * \ingroup PkgAABB_tree + * \ingroup PkgAABB_treeRef * Primitive type that uses as identifier an iterator with a 3D triangle as `value_type`. * The iterator from which the primitive is built should not be invalided * while the AABB tree holding the primitive is in use. diff --git a/AABB_tree/include/CGAL/AABB_triangulation_3_triangle_primitive.h b/AABB_tree/include/CGAL/AABB_triangulation_3_triangle_primitive.h index 96f4b305f28..7a09c780030 100644 --- a/AABB_tree/include/CGAL/AABB_triangulation_3_triangle_primitive.h +++ b/AABB_tree/include/CGAL/AABB_triangulation_3_triangle_primitive.h @@ -31,7 +31,7 @@ #include namespace CGAL { - // \ingroup PkgAABB_tree + // \ingroup PkgAABB_treeRef // Primitive type that wraps a facet handle of a CGAL::Triangulation_3, // which is used as id, and allows the construction of the datum on // the fly. Since only the facet handle is stored in this primitive, diff --git a/Advancing_front_surface_reconstruction/doc/Advancing_front_surface_reconstruction/PackageDescription.txt b/Advancing_front_surface_reconstruction/doc/Advancing_front_surface_reconstruction/PackageDescription.txt index 8e104c34c35..02dd623245b 100644 --- a/Advancing_front_surface_reconstruction/doc/Advancing_front_surface_reconstruction/PackageDescription.txt +++ b/Advancing_front_surface_reconstruction/doc/Advancing_front_surface_reconstruction/PackageDescription.txt @@ -1,7 +1,7 @@ -/// \defgroup PkgAdvancingFrontSurfaceReconstruction Advancing Front Surface Reconstruction Reference +/// \defgroup PkgAdvancingFrontSurfaceReconstructionRef Advancing Front Surface Reconstruction Reference /*! -\addtogroup PkgAdvancingFrontSurfaceReconstruction +\addtogroup PkgAdvancingFrontSurfaceReconstructionRef \cgalPkgDescriptionBegin{Advancing Front Surface Reconstruction,PkgAdvancingFrontSurfaceReconstructionSummary} \cgalPkgPicture{afsr-detail.png} @@ -12,7 +12,7 @@ unorganized point set. Starting from a seed facet, a piecewise linear surface is grown by adding Delaunay triangles one by one. The most plausible triangles are added first, in a way that avoids the appearance of topological singularities. } -\cgalPkgManuals{Chapter_Advancing_Front_Surface_Reconstruction,PkgAdvancingFrontSurfaceReconstruction} +\cgalPkgManuals{Chapter_Advancing_Front_Surface_Reconstruction,PkgAdvancingFrontSurfaceReconstructionRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{4.7} diff --git a/Advancing_front_surface_reconstruction/include/CGAL/Advancing_front_surface_reconstruction.h b/Advancing_front_surface_reconstruction/include/CGAL/Advancing_front_surface_reconstruction.h index 6fc6e33b4d8..f97c3bca853 100644 --- a/Advancing_front_surface_reconstruction/include/CGAL/Advancing_front_surface_reconstruction.h +++ b/Advancing_front_surface_reconstruction/include/CGAL/Advancing_front_surface_reconstruction.h @@ -175,7 +175,7 @@ namespace CGAL { /*! - \ingroup PkgAdvancingFrontSurfaceReconstruction + \ingroup PkgAdvancingFrontSurfaceReconstructionRef The class `Advancing_front_surface_reconstruction` enables advanced users to provide the unstructured point cloud in a 3D Delaunay triangulation. The reconstruction algorithm then marks vertices and faces @@ -2480,7 +2480,7 @@ namespace CGAL { } /*! - \ingroup PkgAdvancingFrontSurfaceReconstruction + \ingroup PkgAdvancingFrontSurfaceReconstructionRef For a sequence of points computes a sequence of index triples describing the faces of the reconstructed surface. @@ -2532,7 +2532,7 @@ namespace CGAL { } /*! - \ingroup PkgAdvancingFrontSurfaceReconstruction + \ingroup PkgAdvancingFrontSurfaceReconstructionRef For a sequence of points computes a sequence of index triples describing the faces of the reconstructed surface. diff --git a/Advancing_front_surface_reconstruction/include/CGAL/Advancing_front_surface_reconstruction_cell_base_3.h b/Advancing_front_surface_reconstruction/include/CGAL/Advancing_front_surface_reconstruction_cell_base_3.h index 99cfa924cdf..eac9e519d77 100644 --- a/Advancing_front_surface_reconstruction/include/CGAL/Advancing_front_surface_reconstruction_cell_base_3.h +++ b/Advancing_front_surface_reconstruction/include/CGAL/Advancing_front_surface_reconstruction_cell_base_3.h @@ -28,7 +28,7 @@ namespace CGAL { /*! - \ingroup PkgAdvancingFrontSurfaceReconstruction + \ingroup PkgAdvancingFrontSurfaceReconstructionRef The class `Advancing_front_surface_reconstruction_cell_base_3` is the default cell type for the class `Advancing_front_surface_reconstruction`. diff --git a/Advancing_front_surface_reconstruction/include/CGAL/Advancing_front_surface_reconstruction_vertex_base_3.h b/Advancing_front_surface_reconstruction/include/CGAL/Advancing_front_surface_reconstruction_vertex_base_3.h index 1d381ccc89c..050e14036fd 100644 --- a/Advancing_front_surface_reconstruction/include/CGAL/Advancing_front_surface_reconstruction_vertex_base_3.h +++ b/Advancing_front_surface_reconstruction/include/CGAL/Advancing_front_surface_reconstruction_vertex_base_3.h @@ -38,7 +38,7 @@ namespace CGAL { template class Advancing_front_surface_reconstruction; /*! - \ingroup PkgAdvancingFrontSurfaceReconstruction + \ingroup PkgAdvancingFrontSurfaceReconstructionRef The class `Advancing_front_surface_reconstruction_vertex_base_3` is the default vertex type for the class `Advancing_front_surface_reconstruction`. diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Algebraic_foundations.txt b/Algebraic_foundations/doc/Algebraic_foundations/Algebraic_foundations.txt index 7e6c7d0039d..6e08371d24e 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Algebraic_foundations.txt +++ b/Algebraic_foundations/doc/Algebraic_foundations/Algebraic_foundations.txt @@ -81,7 +81,7 @@ compatibility all functionality is also accessible through global functions defined within namespace `CGAL`, e.g., \link sqrt `CGAL::sqrt(x)` \endlink. This is realized via function templates using the according functor of the traits class. For an overview see -Section \ref PkgAlgebraicFoundations in the reference manual. +Section \ref PkgAlgebraicFoundationsRef in the reference manual. \subsection Algebraic_foundationsTagsinAlgebraicStructure Tags in Algebraic Structure Traits diff --git a/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Algebraic_structure_traits.h b/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Algebraic_structure_traits.h index 38d35c6cf27..fee8e9b1daa 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Algebraic_structure_traits.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Algebraic_structure_traits.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef An instance of `Algebraic_structure_traits` is a model of `AlgebraicStructureTraits`, where T is the associated type. @@ -17,7 +17,7 @@ class Algebraic_structure_traits { namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef Tag indicating that a type is a model of the `EuclideanRing` concept. @@ -34,7 +34,7 @@ struct Euclidean_ring_tag : public Unique_factorization_domain_tag { }; /* end Euclidean_ring_tag */ /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef Tag indicating that a type is a model of the `Field` concept. @@ -50,7 +50,7 @@ struct Field_tag : public Integral_domain_tag { }; /* end Field_tag */ /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef Tag indicating that a type is a model of the `FieldWithKthRoot` concept. @@ -66,7 +66,7 @@ struct Field_with_kth_root_tag : public Field_with_sqrt_tag { }; /* end Field_with_kth_root_tag */ /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef Tag indicating that a type is a model of the `FieldWithRootOf` concept. @@ -82,7 +82,7 @@ struct Field_with_root_of_tag : public Field_with_kth_root_tag { }; /* end Field_with_root_of_tag */ /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef Tag indicating that a type is a model of the `FieldWithSqrt` concept. @@ -98,7 +98,7 @@ struct Field_with_sqrt_tag : public Field_tag { }; /* end Field_with_sqrt_tag */ /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef Tag indicating that a type is a model of the `IntegralDomain` concept. @@ -114,7 +114,7 @@ struct Integral_domain_tag : public Integral_domain_without_division_tag { }; /* end Integral_domain_tag */ /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef Tag indicating that a type is a model of the `IntegralDomainWithoutDivision` concept. @@ -129,7 +129,7 @@ struct Integral_domain_without_division_tag { }; /* end Integral_domain_without_division_tag */ /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef Tag indicating that a type is a model of the `UniqueFactorizationDomain` concept. diff --git a/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Coercion_traits.h b/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Coercion_traits.h index 7c1bbf3fbcb..51241f2fec2 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Coercion_traits.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Coercion_traits.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef An instance of `Coercion_traits` reflects the type coercion of the types A and B, it is symmetric in the two template arguments. diff --git a/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Fraction_traits.h b/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Fraction_traits.h index 0e2575ec3cf..5888f705f3f 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Fraction_traits.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Fraction_traits.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef An instance of `Fraction_traits` is a model of `FractionTraits`, where `T` is the associated type. diff --git a/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Real_embeddable_traits.h b/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Real_embeddable_traits.h index d4f7b67e6b8..fa61be8f8df 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Real_embeddable_traits.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Real_embeddable_traits.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef An instance of `Real_embeddable_traits` is a model of `RealEmbeddableTraits`, where T is the associated type. diff --git a/Algebraic_foundations/doc/Algebraic_foundations/CGAL/number_utils.h b/Algebraic_foundations/doc/Algebraic_foundations/CGAL/number_utils.h index 28fe692ade1..153988e6d93 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/CGAL/number_utils.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/CGAL/number_utils.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The template function `abs()` returns the absolute value of a number. @@ -19,7 +19,7 @@ template NT abs(const NT& x); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The template function `compare()` compares the first argument with respect to the second, i.e.\ it returns `CGAL::LARGER` if \f$ x\f$ is larger then \f$ y\f$. @@ -43,7 +43,7 @@ result_type compare(const NT &x, const NT &y); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The function `div()` computes the integral quotient of division with remainder. @@ -74,7 +74,7 @@ div(const NT1& x, const NT2& y); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef computes the quotient \f$ q\f$ and remainder \f$ r\f$, such that \f$ x = q*y + r\f$ and \f$ r\f$ minimal with respect to the Euclidean Norm of the @@ -109,7 +109,7 @@ div_mod(const NT1& x, const NT2& y, result_type& q, result_type& r); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The function `gcd()` computes the greatest common divisor of two values. @@ -136,7 +136,7 @@ gcd(const NT1& x, const NT2& y); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The function `integral_division()` (a.k.a.\ exact division or division without remainder) maps ring elements \f$ (x,y)\f$ to ring element \f$ z\f$ such that \f$ x = yz\f$ if such a \f$ z\f$ @@ -167,7 +167,7 @@ integral_division(const NT1& x, const NT2& y); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The function `inverse()` returns the inverse element with respect to multiplication. @@ -187,7 +187,7 @@ template NT inverse(const NT& x); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The template function `is_negative()` determines if a value is negative or not. The function is defined if the argument type @@ -206,7 +206,7 @@ result_type is_negative(const NT& x); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The function `is_one()` determines if a value is equal to 1 or not. @@ -226,7 +226,7 @@ template result_type is_one(const NT& x); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The template function `is_positive()` determines if a value is positive or not. The function is defined if the argument type @@ -245,7 +245,7 @@ result_type is_positive(const NT& x); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef An ring element \f$ x\f$ is said to be a square iff there exists a ring element \f$ y\f$ such @@ -264,7 +264,7 @@ The `result_type` is convertible to `bool`. template result_type is_square(const NT& x); /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef An ring element \f$ x\f$ is said to be a square iff there exists a ring element \f$ y\f$ such @@ -287,7 +287,7 @@ template result_type is_square(const NT& x, NT& y); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The function `is_zero()` determines if a value is equal to 0 or not. @@ -309,7 +309,7 @@ template result_type is_zero(const NT& x); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The function `kth_root()` returns the k-th root of a value. @@ -327,7 +327,7 @@ template NT kth_root(int k, const NT& x); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The function `mod()` computes the remainder of division with remainder. @@ -357,7 +357,7 @@ mod(const NT1& x, const NT2& y); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef returns the k-th real root of the univariate polynomial, which is defined by the iterator range, where begin refers to the constant @@ -383,7 +383,7 @@ root_of(int k, InputIterator begin, InputIterator end); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The template function `sign()` returns the sign of its argument. @@ -403,7 +403,7 @@ template result_type sign(const NT& x); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The function `simplify()` may simplify a given object. @@ -421,7 +421,7 @@ template void simplify(const NT& x); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The function `sqrt()` returns the square root of a value. @@ -439,7 +439,7 @@ template NT sqrt(const NT& x); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The function `square()` returns the square of a number. @@ -457,7 +457,7 @@ template NT square(const NT& x); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The template function `to_double()` returns a double approximation of a number. Note that in general, the value returned is not guaranteed to be the same @@ -482,7 +482,7 @@ template double to_double(const NT& x); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The template function `to_interval()` computes for a given real embeddable number \f$ x\f$ a double interval containing \f$ x\f$. @@ -502,7 +502,7 @@ std::pair to_interval(const NT& x); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The function `unit_part()` computes the unit part of a given ring element. diff --git a/Algebraic_foundations/doc/Algebraic_foundations/PackageDescription.txt b/Algebraic_foundations/doc/Algebraic_foundations/PackageDescription.txt index 9a5d49ffebf..90344ec0532 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/PackageDescription.txt +++ b/Algebraic_foundations/doc/Algebraic_foundations/PackageDescription.txt @@ -1,10 +1,10 @@ -/// \defgroup PkgAlgebraicFoundations Algebraic Foundations Reference +/// \defgroup PkgAlgebraicFoundationsRef Algebraic Foundations Reference /// \defgroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts Concepts -/// \ingroup PkgAlgebraicFoundations +/// \ingroup PkgAlgebraicFoundationsRef /*! -\addtogroup PkgAlgebraicFoundations +\addtogroup PkgAlgebraicFoundationsRef \todo check generated documentation \cgalPkgDescriptionBegin{Algebraic Foundations,PkgAlgebraicFoundationsSummary} @@ -12,7 +12,7 @@ \cgalPkgSummaryBegin \cgalPkgAuthor{Michael Hemmer} \cgalPkgDesc{This package defines what algebra means for \cgal, in terms of concepts, classes and functions. The main features are: (i) explicit concepts for interoperability of types (ii) separation between algebraic types (not necessarily embeddable into the reals), and number types (embeddable into the reals).} -\cgalPkgManuals{Chapter_Algebraic_Foundations,PkgAlgebraicFoundations} +\cgalPkgManuals{Chapter_Algebraic_Foundations,PkgAlgebraicFoundationsRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.3} diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/PackageDescription.txt b/Algebraic_kernel_d/doc/Algebraic_kernel_d/PackageDescription.txt index c47391fc374..026e6256c10 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/PackageDescription.txt +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/PackageDescription.txt @@ -1,7 +1,7 @@ -/// \defgroup PkgAlgebraicKerneld Algebraic Kernel Reference +/// \defgroup PkgAlgebraicKerneldRef Algebraic Kernel Reference /// \defgroup PkgAlgebraicKerneldConcepts Concepts -/// \ingroup PkgAlgebraicKerneld +/// \ingroup PkgAlgebraicKerneldRef /// \defgroup PkgAlgebraicKerneldConceptsUni Univariate Algebraic Kernel /// \ingroup PkgAlgebraicKerneldConcepts @@ -11,18 +11,18 @@ /// \defgroup PkgAlgebraicKerneldModels Models -/// \ingroup PkgAlgebraicKerneld +/// \ingroup PkgAlgebraicKerneldRef /*! -\addtogroup PkgAlgebraicKerneld +\addtogroup PkgAlgebraicKerneldRef \todo check generated documentation \cgalPkgDescriptionBegin{Algebraic Kernel,PkgAlgebraicKerneldSummary} \cgalPkgPicture{Algebraic_kernel_d.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Eric Berberich, Michael Hemmer, Michael Kerber, Sylvain Lazard, Luis Peñaranda, and Monique Teillaud} \cgalPkgDesc{Real solving of polynomials is a fundamental problem with a wide application range. This package is targeted to provide black-box implementations of state-of-the-art algorithms to determine, compare and approximate real roots of univariate polynomials and bivariate polynomial systems. Such a black-box is called an *Algebraic %Kernel*. So far the package only provides models for the univariate kernel. Nevertheless, it already defines concepts for the bivariate kernel, since this settles the interface for upcoming implementations.} -\cgalPkgManuals{Chapter_Algebraic_Kernel,PkgAlgebraicKerneld} +\cgalPkgManuals{Chapter_Algebraic_Kernel,PkgAlgebraicKerneldRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.6} diff --git a/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_2.h b/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_2.h index fd3f480a7fb..2a36d775be3 100644 --- a/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_2.h +++ b/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgAlphaShape2 +\ingroup PkgAlphaShape2Ref The class `Alpha_shape_2` represents the family of \f$ \alpha\f$-shapes of points in a plane for all positive diff --git a/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_face_base_2.h b/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_face_base_2.h index b6a5a330ae5..8c546ceaf93 100644 --- a/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_face_base_2.h +++ b/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_face_base_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgAlphaShape2 +\ingroup PkgAlphaShape2Ref The class `Alpha_shape_face_base_2` is the default model for the concept `AlphaShapeFace_2`. diff --git a/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_vertex_base_2.h b/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_vertex_base_2.h index f20b2dfe563..7d71cdd8e7c 100644 --- a/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_vertex_base_2.h +++ b/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_vertex_base_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgAlphaShape2 +\ingroup PkgAlphaShape2Ref The class `Alpha_shape_vertex_base_2` is the default model for the concept `AlphaShapeVertex_2`. diff --git a/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Weighted_alpha_shape_euclidean_traits_2.h b/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Weighted_alpha_shape_euclidean_traits_2.h index 93852d99a12..b7952e42f93 100644 --- a/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Weighted_alpha_shape_euclidean_traits_2.h +++ b/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Weighted_alpha_shape_euclidean_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgAlphaShape2 +\ingroup PkgAlphaShape2Ref \deprecated The class is deprecated since \cgal 4.10, as the weighted point and the function objects for weighted points are part of the concept `Kernel`. The class is kept for backward diff --git a/Alpha_shapes_2/doc/Alpha_shapes_2/PackageDescription.txt b/Alpha_shapes_2/doc/Alpha_shapes_2/PackageDescription.txt index 89f592fe677..1d563f2db90 100644 --- a/Alpha_shapes_2/doc/Alpha_shapes_2/PackageDescription.txt +++ b/Alpha_shapes_2/doc/Alpha_shapes_2/PackageDescription.txt @@ -1,16 +1,16 @@ -/// \defgroup PkgAlphaShape2 2D Alpha Shapes Reference +/// \defgroup PkgAlphaShape2Ref 2D Alpha Shapes Reference /// \defgroup PkgAlphaShape2Concepts Concepts -/// \ingroup PkgAlphaShape2 +/// \ingroup PkgAlphaShape2Ref /*! -\addtogroup PkgAlphaShape2 +\addtogroup PkgAlphaShape2Ref \cgalPkgDescriptionBegin{2D Alpha Shapes,PkgAlphaShape2Summary} \cgalPkgPicture{alpha-detail.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Tran Kai Frank Da} \cgalPkgDesc{This package offers a data structure encoding the whole family of alpha-complexes related to a given 2D Delaunay or regular triangulation. In particular, the data structure allows to retrieve the alpha-complex for any alpha value, the whole spectrum of critical alpha values and a filtration on the triangulation faces (this filtration is based on the first alpha value for which each face is included on the alpha-complex).} -\cgalPkgManuals{Chapter_2D_Alpha_Shapes,PkgAlphaShape2} +\cgalPkgManuals{Chapter_2D_Alpha_Shapes,PkgAlphaShape2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{2.1} diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_3.h index 52f081ba007..e1e14111ed0 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgAlphaShapes3 +\ingroup PkgAlphaShapes3Ref The class `Alpha_shape_3` represents the family of alpha shapes of points in the 3D space for all real diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_cell_base_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_cell_base_3.h index f733d1a9a8c..b57d44fe618 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_cell_base_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_cell_base_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgAlphaShapes3 +\ingroup PkgAlphaShapes3Ref The class `Alpha_shape_cell_base_3` is the default model for the concept `AlphaShapeCell_3`. @@ -37,7 +37,7 @@ public: namespace CGAL { /*! -\ingroup PkgAlphaShapes3 +\ingroup PkgAlphaShapes3Ref The class `Alpha_status` is a small data structure to store the critical alpha values of faces of an alpha shape. diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_vertex_base_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_vertex_base_3.h index 48a900c3234..146a941e218 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_vertex_base_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_vertex_base_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgAlphaShapes3 +\ingroup PkgAlphaShapes3Ref The class `Alpha_shape_vertex_base_3` is the default model for the concept `AlphaShapeVertex_3`. diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_3.h index 71b7394b4ef..d7bad466690 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgAlphaShapes3 +\ingroup PkgAlphaShapes3Ref The class `Fixed_alpha_shape_3` represents one (fixed) alpha shape of points in the 3D space for a real diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_cell_base_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_cell_base_3.h index 776e787b20c..ab50625bfd5 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_cell_base_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_cell_base_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgAlphaShapes3 +\ingroup PkgAlphaShapes3Ref The class `Fixed_alpha_shape_cell_base_3` is the default model for the concept `FixedAlphaShapeCell_3`. diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_vertex_base_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_vertex_base_3.h index d512a99e4a0..5c132505980 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_vertex_base_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_vertex_base_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgAlphaShapes3 +\ingroup PkgAlphaShapes3Ref The class `Fixed_alpha_shape_vertex_base_3` is the default model for the concept `FixedAlphaShapeVertex_3`. diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/PackageDescription.txt b/Alpha_shapes_3/doc/Alpha_shapes_3/PackageDescription.txt index 279faf91035..7ddf096a7ad 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/PackageDescription.txt +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/PackageDescription.txt @@ -1,14 +1,14 @@ -/// \defgroup PkgAlphaShapes3 3D Alpha Shapes Reference +/// \defgroup PkgAlphaShapes3Ref 3D Alpha Shapes Reference /// \defgroup PkgAlphaShapes3Concepts Concepts -/// \ingroup PkgAlphaShapes3 +/// \ingroup PkgAlphaShapes3Ref /*! -\addtogroup PkgAlphaShapes3 +\addtogroup PkgAlphaShapes3Ref \cgalPkgDescriptionBegin{3D Alpha Shapes,PkgAlphaShapes3Summary} \cgalPkgPicture{alpha_shapes_3_small.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Tran Kai Frank Da, Sébastien Loriot, and Mariette Yvinec} \cgalPkgDesc{This package offers a data structure encoding either one alpha-complex or the whole family of alpha-complexes related to a given 3D Delaunay or regular triangulation. In the latter case, the data structure allows to retrieve the alpha-complex for any alpha value, the whole spectrum of critical alpha values and a filtration on the triangulation faces (this filtration is based on the first alpha value for which each face is included on the alpha-complex). } -\cgalPkgManuals{Chapter_3D_Alpha_Shapes,PkgAlphaShapes3} +\cgalPkgManuals{Chapter_3D_Alpha_Shapes,PkgAlphaShapes3Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{2.3} diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_2.h index 27bb8401c69..6716e9095da 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgApolloniusGraph2 +\ingroup PkgApolloniusGraph2Ref The class `Apollonius_graph_2` represents the Apollonius graph. It supports insertions and deletions of sites. diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_filtered_traits_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_filtered_traits_2.h index 8f972d24d33..a1b4a8003d5 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_filtered_traits_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_filtered_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgApolloniusGraph2 +\ingroup PkgApolloniusGraph2Ref The class `Apollonius_graph_filtered_traits_2` provides a model for the `ApolloniusGraphTraits_2` concept. diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_hierarchy_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_hierarchy_2.h index 863167f6e3b..6456ef59549 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_hierarchy_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_hierarchy_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgApolloniusGraph2 +\ingroup PkgApolloniusGraph2Ref We provide an alternative to the class `Apollonius_graph_2` for the dynamic diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_hierarchy_vertex_base_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_hierarchy_vertex_base_2.h index d04be3c9250..5dd5bf06793 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_hierarchy_vertex_base_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_hierarchy_vertex_base_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgApolloniusGraph2 +\ingroup PkgApolloniusGraph2Ref The class `Apollonius_graph_hierarchy_vertex_base_2` provides a model for the `ApolloniusGraphHierarchyVertexBase_2` concept, which is the diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_traits_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_traits_2.h index bdd1cc2b503..6f3d11a7517 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_traits_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgApolloniusGraph2 +\ingroup PkgApolloniusGraph2Ref The class `Apollonius_graph_traits_2` provides a model for the `ApolloniusGraphTraits_2` concept. diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_vertex_base_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_vertex_base_2.h index a1ab5ac7b74..c86d80b0b1a 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_vertex_base_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_vertex_base_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgApolloniusGraph2 +\ingroup PkgApolloniusGraph2Ref The class `Apollonius_graph_vertex_base_2` provides a model for the `ApolloniusGraphVertexBase_2` concept which is the vertex base diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_site_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_site_2.h index fe4ddc0de0d..a77be4d6fe1 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_site_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_site_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgApolloniusGraph2 +\ingroup PkgApolloniusGraph2Ref The class `Apollonius_site_2` is a model for the concept `ApolloniusSite_2`. It is parametrized by a template parameter diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/PackageDescription.txt b/Apollonius_graph_2/doc/Apollonius_graph_2/PackageDescription.txt index a8b8e8c267c..caa9d9b5f44 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/PackageDescription.txt +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/PackageDescription.txt @@ -1,15 +1,15 @@ -/// \defgroup PkgApolloniusGraph2 2D Apollonius Graphs (Delaunay Graphs of Disks) Reference +/// \defgroup PkgApolloniusGraph2Ref 2D Apollonius Graphs (Delaunay Graphs of Disks) Reference /// \defgroup PkgApolloniusGraph2Concepts Concepts -/// \ingroup PkgApolloniusGraph2 +/// \ingroup PkgApolloniusGraph2Ref /*! -\addtogroup PkgApolloniusGraph2 +\addtogroup PkgApolloniusGraph2Ref \todo check generated documentation \cgalPkgDescriptionBegin{2D Apollonius Graphs (Delaunay Graphs of Disks),PkgApolloniusGraph2Summary} \cgalPkgPicture{CircleVoronoi.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Menelaos Karavelas and Mariette Yvinec} \cgalPkgDesc{Algorithms for computing the Apollonius graph in two dimensions. The Apollonius graph is the dual of the Apollonius diagram, also known as the additively weighted Voronoi diagram. The latter can be thought of as the Voronoi diagram of a set of disks under the Euclidean metric, and it is a generalization of the standard Voronoi diagram for points. The algorithms provided are dynamic.} -\cgalPkgManuals{Chapter_2D_Apollonius_Graphs,PkgApolloniusGraph2} +\cgalPkgManuals{Chapter_2D_Apollonius_Graphs,PkgApolloniusGraph2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.0} diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_accessor.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_accessor.h index 68be885d043..70802debe79 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_accessor.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_accessor.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2 +\ingroup PkgArrangement2Ref \anchor arr_refarr_access diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_face_index_map.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_face_index_map.h index c816ecd0a52..c451dd765b4 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_face_index_map.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_face_index_map.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2 +\ingroup PkgArrangement2Ref `Arr_face_index_map` maintains a mapping of face handles of an attached arrangement object to indices (of type `unsigned int`). diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_observer.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_observer.h index 20c9cfbecb7..cdad68c7085 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_observer.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_observer.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2 +\ingroup PkgArrangement2Ref \anchor arr_refarr_obs diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_vertex_index_map.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_vertex_index_map.h index c00dd12499a..7abba736a92 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_vertex_index_map.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_vertex_index_map.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2 +\ingroup PkgArrangement2Ref `Arr_vertex_index_map` maintains a mapping of vertex handles of an attached arrangement object to indices (of type `unsigned int`). 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 277ddf71eca..dd84f261e99 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 @@ -1,7 +1,7 @@ namespace CGAL { /*! - \ingroup PkgArrangement2 + \ingroup PkgArrangement2Ref \anchor arr_refarr diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arrangement_with_history_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arrangement_with_history_2.h index 7afef234acc..7d89aab47b0 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arrangement_with_history_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arrangement_with_history_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2 +\ingroup PkgArrangement2Ref \anchor arr_refarr_with_hist diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/PackageDescription.txt b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/PackageDescription.txt index 844048f8e23..37a821ce963 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/PackageDescription.txt +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/PackageDescription.txt @@ -1,7 +1,7 @@ -/// \defgroup PkgArrangement2 2D Arrangement Reference +/// \defgroup PkgArrangement2Ref 2D Arrangement Reference /// \defgroup PkgArrangement2Concepts Concepts -/// \ingroup PkgArrangement2 +/// \ingroup PkgArrangement2Ref /// \cgalConceptNamespace /// The namespace containing concepts specific to Arrangements. @@ -20,13 +20,13 @@ namespace ArrTraits {} /// \ingroup PkgArrangement2Concepts /// \defgroup PkgArrangement2TraitsClasses Traits Classes -/// \ingroup PkgArrangement2 +/// \ingroup PkgArrangement2Ref /// \defgroup PkgArrangement2DCEL DCEL -/// \ingroup PkgArrangement2 +/// \ingroup PkgArrangement2Ref /// \defgroup PkgArrangement2IO I/O -/// \ingroup PkgArrangement2 +/// \ingroup PkgArrangement2Ref /// \defgroup PkgArrangement2op_left_shift operator<< /// \ingroup PkgArrangement2IO @@ -35,35 +35,35 @@ namespace ArrTraits {} /// \ingroup PkgArrangement2IO /// \defgroup PkgArrangement2PointLocation Point Location -/// \ingroup PkgArrangement2 +/// \ingroup PkgArrangement2Ref /// \defgroup PkgArrangement2Overlay Overlay -/// \ingroup PkgArrangement2 +/// \ingroup PkgArrangement2Ref /// \defgroup PkgArrangement2Funcs Free Functions -/// \ingroup PkgArrangement2 +/// \ingroup PkgArrangement2Ref /// \defgroup PkgArrangement2Insert CGAL::insert() /// \ingroup PkgArrangement2Funcs /// \defgroup PkgArrangement2Tags Tags -/// \ingroup PkgArrangement2 +/// \ingroup PkgArrangement2Ref /// \defgroup PkgArrangement2Macros Macros -/// \ingroup PkgArrangement2 +/// \ingroup PkgArrangement2Ref /// \defgroup PkgArrangement2Enums Enumerations -/// \ingroup PkgArrangement2 +/// \ingroup PkgArrangement2Ref /*! -\addtogroup PkgArrangement2 +\addtogroup PkgArrangement2Ref \todo check generated documentation \cgalPkgDescriptionBegin{2D Arrangements,PkgArrangement2Summary} \cgalPkgPicture{Arrangement_2.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Ron Wein, Eric Berberich, Efi Fogel, Dan Halperin, Michael Hemmer, Oren Salzman, and Baruch Zukerman} \cgalPkgDesc{This package can be used to construct, maintain, alter, and display arrangements in the plane. Once an arrangement is constructed, the package can be used to obtain results of various queries on the arrangement, such as point location. The package also includes generic implementations of two algorithmic frameworks, that are, computing the zone of an arrangement, and line-sweeping the plane, the arrangements is embedded on. These frameworks are used in turn in the implementations of other operations on arrangements. Computing the overlay of two arrangements, for example, is based on the sweep-line framework. Arrangements and arrangement components can also be extended to store additional data. An important extension stores the construction history of the arrangement, such that it is possible to obtain the originating curve of an arrangement subcurve.} -\cgalPkgManuals{Chapter_2D_Arrangements,PkgArrangement2} +\cgalPkgManuals{Chapter_2D_Arrangements,PkgArrangement2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{2.1} diff --git a/BGL/doc/BGL/NamedParameters.txt b/BGL/doc/BGL/NamedParameters.txt index 9100d01d6fd..f775e26ce48 100644 --- a/BGL/doc/BGL/NamedParameters.txt +++ b/BGL/doc/BGL/NamedParameters.txt @@ -1,6 +1,6 @@ /*! \defgroup bgl_namedparameters BGL Named Parameters -\ingroup PkgBGL +\ingroup PkgBGLRef The algorithms of the \sc{Bgl} often have many parameters with default values that are appropriate for most cases. In general, when no diff --git a/BGL/doc/BGL/PackageDescription.txt b/BGL/doc/BGL/PackageDescription.txt index 85411a04874..557af29e8ab 100644 --- a/BGL/doc/BGL/PackageDescription.txt +++ b/BGL/doc/BGL/PackageDescription.txt @@ -1,7 +1,7 @@ -/// \defgroup PkgBGL CGAL and the Boost Graph Library Reference +/// \defgroup PkgBGLRef CGAL and the Boost Graph Library Reference /*! \defgroup PkgBGLConcepts Concepts - \ingroup PkgBGL + \ingroup PkgBGLRef We extend the Boost Graph Library (\sc{Bgl} for short) with a set of new concepts. In order to make this documentation self-contained we here also document @@ -438,34 +438,34 @@ the requirement for traversal of all faces in a graph. /// The property tags model of the boost concept PropertyTag. /// These tags are used to retrieve default property maps using the traits class boost::property_map. /// \defgroup PkgBGLProperties Properties -/// \ingroup PkgBGL +/// \ingroup PkgBGLRef /// \defgroup PkgBGLPropertiesDynamic Dynamic Properties -/// \ingroup PkgBGL +/// \ingroup PkgBGLRef /// \defgroup PkgBGLHelper Helper Classes -/// \ingroup PkgBGL +/// \ingroup PkgBGLRef /// \defgroup PkgBGLHelperFct Helper Functions -/// \ingroup PkgBGL +/// \ingroup PkgBGLRef /// \defgroup PkgBGLIterators Iterators and Circulators -/// \ingroup PkgBGL +/// \ingroup PkgBGLRef /// \defgroup PkgBGLSelectionFct Selection Functions -/// \ingroup PkgBGL +/// \ingroup PkgBGLRef /// \defgroup PkgBGLAdaptors Graph Adaptors -/// \ingroup PkgBGL +/// \ingroup PkgBGLRef /// \defgroup PkgBGLEulerOperations Euler Operations -/// \ingroup PkgBGL +/// \ingroup PkgBGLRef /// \defgroup PkgBGLPartition Partitioning Operations -/// \ingroup PkgBGL +/// \ingroup PkgBGLRef /// \defgroup PkgBGLIOFct I/O Functions -/// \ingroup PkgBGL +/// \ingroup PkgBGLRef /*! \addtogroup PkgBGLPropertiesDynamic @@ -541,13 +541,13 @@ Methods to read and write graphs. /*! -\addtogroup PkgBGL +\addtogroup PkgBGLRef \cgalPkgDescriptionBegin{CGAL and the Boost Graph Library,PkgBGLSummary} \cgalPkgPicture{emst-detail.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Andreas Fabri, Fernando Cacciola, Philipp Moeller, and Ron Wein} \cgalPkgDesc{This package provides a framework for interfacing \cgal data structures with the algorithms of the Boost Graph Library, or \sc{BGL} for short. It allows to run graph algorithms directly on \cgal data structures which are model of the \sc{BGL} graph concepts, for example the shortest path algorithm on a Delaunay triangulation in order to compute the Euclidean minimum spanning tree. Furthermore, it introduces several new graph concepts describing halfedge data structures.} -\cgalPkgManuals{Chapter_CGAL_and_the_Boost_Graph_Library,PkgBGL} +\cgalPkgManuals{Chapter_CGAL_and_the_Boost_Graph_Library,PkgBGLRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.3} diff --git a/BGL/doc/BGL/graph_traits.txt b/BGL/doc/BGL/graph_traits.txt index ce760aebcde..bbc9deabdd9 100644 --- a/BGL/doc/BGL/graph_traits.txt +++ b/BGL/doc/BGL/graph_traits.txt @@ -1,7 +1,7 @@ /*! \defgroup PkgBGLTraits Specializations of boost::graph_traits -\ingroup PkgBGL +\ingroup PkgBGLRef The \sc{Bgl} defines the class template `boost::graph_traits` diff --git a/BGL/include/CGAL/boost/graph/partition.h b/BGL/include/CGAL/boost/graph/partition.h index 129e2421e13..a6bf761fccb 100644 --- a/BGL/include/CGAL/boost/graph/partition.h +++ b/BGL/include/CGAL/boost/graph/partition.h @@ -22,7 +22,7 @@ #define CGAL_BGL_PARTITION_H /** -* \ingroup PkgBGL +* \ingroup PkgBGLRef * \file CGAL/boost/graph/partition.h * Convenience header file including the headers for all the partitioning-related * free functions of this package. diff --git a/BGL/include/CGAL/boost/graph/split_graph_into_polylines.h b/BGL/include/CGAL/boost/graph/split_graph_into_polylines.h index 09fe353349b..2fc9ed6b461 100644 --- a/BGL/include/CGAL/boost/graph/split_graph_into_polylines.h +++ b/BGL/include/CGAL/boost/graph/split_graph_into_polylines.h @@ -203,7 +203,7 @@ void duplicate_terminal_vertices(Graph& graph, /*! -\ingroup PkgBGL +\ingroup PkgBGLRef splits into polylines the graph `g` at vertices of degree greater than 2 and at vertices for which `is_terminal(v,graph)==true`. The polylines are reported using a visitor. diff --git a/Barycentric_coordinates_2/doc/Barycentric_coordinates_2/Barycentric_coordinates_2.txt b/Barycentric_coordinates_2/doc/Barycentric_coordinates_2/Barycentric_coordinates_2.txt index da226aedf29..c022f02d017 100644 --- a/Barycentric_coordinates_2/doc/Barycentric_coordinates_2/Barycentric_coordinates_2.txt +++ b/Barycentric_coordinates_2/doc/Barycentric_coordinates_2/Barycentric_coordinates_2.txt @@ -26,7 +26,7 @@ Segment and triangle coordinates can be computed by using either a global functi Any point in the plane may be taken as a query point. However, we do not recommend to use Wachspress and discrete harmonic coordinates with query points outside the closure of a polygon because at some of those points these coordinates are not well-defined, as explained in the Section \ref gbc_degeneracies. -Once instantiated for some polygon, the coordinates can be computed multiple times for different query points with respect to all the vertices of the provided polygon. Use the \ref PkgBarycentric_coordinates_2 "Reference Manual" for the detailed interface. +Once instantiated for some polygon, the coordinates can be computed multiple times for different query points with respect to all the vertices of the provided polygon. Use the \ref PkgBarycentric_coordinates_2Ref "Reference Manual" for the detailed interface. The output of the computation is a set of coordinate values at the current query point with respect to all the vertices of the polygon. This output can be stored in an arbitrary container providing an appropriate output iterator. In addition, all the classes return a pointer to the last stored element and a status of the computation (Boolean true or false). diff --git a/Barycentric_coordinates_2/doc/Barycentric_coordinates_2/PackageDescription.txt b/Barycentric_coordinates_2/doc/Barycentric_coordinates_2/PackageDescription.txt index 29cae2cd33c..42039a5eb61 100644 --- a/Barycentric_coordinates_2/doc/Barycentric_coordinates_2/PackageDescription.txt +++ b/Barycentric_coordinates_2/doc/Barycentric_coordinates_2/PackageDescription.txt @@ -1,17 +1,17 @@ -/// \defgroup PkgBarycentric_coordinates_2 2D Generalized Barycentric Coordinates Reference +/// \defgroup PkgBarycentric_coordinates_2Ref 2D Generalized Barycentric Coordinates Reference /// \defgroup PkgBarycentric_coordinates_2Concepts Concepts -/// \ingroup PkgBarycentric_coordinates_2 +/// \ingroup PkgBarycentric_coordinates_2Ref /*! -\addtogroup PkgBarycentric_coordinates_2 +\addtogroup PkgBarycentric_coordinates_2Ref \cgalPkgDescriptionBegin{2D Generalized Barycentric Coordinates, PkgBarycentric_coordinates_2Summary} \cgalPkgPicture{barcoord_thumb.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Dmitry Anisimov, David Bommes, Kai Hormann, and Pierre Alliez} \cgalPkgDesc{The package 2D Generalized Barycentric Coordinates offers an efficient and robust implementation of two-dimensional closed-form generalized barycentric coordinates defined for simple two-dimensional polygons. If coordinates with respect to multivariate scattered points instead of a polygon are required, please refer to natural neighbor coordinates from the Package \ref PkgInterpolation2Summary.} -\cgalPkgManuals{Chapter_2D_Generalized_Barycentric_Coordinates, PkgBarycentric_coordinates_2} +\cgalPkgManuals{Chapter_2D_Generalized_Barycentric_Coordinates, PkgBarycentric_coordinates_2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{4.6} diff --git a/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Discrete_harmonic_2.h b/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Discrete_harmonic_2.h index 5ab84f16885..210ad73abd7 100644 --- a/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Discrete_harmonic_2.h +++ b/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Discrete_harmonic_2.h @@ -49,7 +49,7 @@ namespace Barycentric_coordinates { // [1] Reference: "M. S. Floater, K. Hormann, and G. Kos. A general construction of barycentric coordinates over convex polygons. Advances in Computational Mathematics, 24(1-4):311-331, 2006.". /*! - * \ingroup PkgBarycentric_coordinates_2 + * \ingroup PkgBarycentric_coordinates_2Ref * The class `Discrete_harmonic_2` implements 2D discrete harmonic coordinates ( \cite cgal:bc:fhk-gcbcocp-06, \cite cgal:pp-cdmsc-93, \cite cgal:bc:eddhls-maam-95 ). * This class is parameterized by a traits class `Traits`, and it is used as a coordinate class to complete the class `Generalized_barycentric_coordinates_2`. * For a polygon with three vertices (triangle) it is better to use the class `Triangle_coordinates_2`. diff --git a/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Generalized_barycentric_coordinates_2.h b/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Generalized_barycentric_coordinates_2.h index 4bce42d7680..d40da83df11 100644 --- a/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Generalized_barycentric_coordinates_2.h +++ b/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Generalized_barycentric_coordinates_2.h @@ -48,7 +48,7 @@ namespace Barycentric_coordinates { // Examples: see the User Manual here - https://doc.cgal.org/latest/Manual/index.html. /*! - * \ingroup PkgBarycentric_coordinates_2 + * \ingroup PkgBarycentric_coordinates_2Ref * The class `Generalized_barycentric_coordinates_2` implements generalized barycentric coordinates along the polygon's boundary and provides a common interface for all coordinate classes. * This class is parameterized by a coordinate class `Coordinate_2`, and a traits class `Traits`. diff --git a/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Mean_value_2.h b/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Mean_value_2.h index e44a126dc56..ac512446eed 100644 --- a/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Mean_value_2.h +++ b/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Mean_value_2.h @@ -101,7 +101,7 @@ public: // [2] Reference: "M. S. Floater, Wachspress and mean value coordinates, to appear in the Proceedings of the 14th International Conference on Approximation Theory, G. Fasshauer and L. L. Schumaker (eds.)." /*! - * \ingroup PkgBarycentric_coordinates_2 + * \ingroup PkgBarycentric_coordinates_2Ref * The class `Mean_value_2` implements 2D mean value coordinates ( \cite cgal:bc:hf-mvcapp-06, \cite cgal:bc:fhk-gcbcocp-06, \cite cgal:f-mvc-03 ). * This class is parameterized by a traits class `Traits`, and it is used as a coordinate class to complete the class `Generalized_barycentric_coordinates_2`. * For a polygon with three vertices (triangle) it is better to use the class `Triangle_coordinates_2`. diff --git a/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Segment_coordinates_2.h b/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Segment_coordinates_2.h index 34fe8b3ba3b..fd81433a06e 100644 --- a/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Segment_coordinates_2.h +++ b/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Segment_coordinates_2.h @@ -48,7 +48,7 @@ namespace Barycentric_coordinates { // Examples: see the User Manual - https://doc.cgal.org/latest/Manual/index.html. /*! - * \ingroup PkgBarycentric_coordinates_2 + * \ingroup PkgBarycentric_coordinates_2Ref * The class `Segment_coordinates_2` implements barycentric coordinates with respect to an arbitrary non-degenerate segment along an arbitrary line in the plane. * This class is parameterized by a traits class `Traits`. diff --git a/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Triangle_coordinates_2.h b/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Triangle_coordinates_2.h index 8ef6af47752..82086944b5d 100644 --- a/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Triangle_coordinates_2.h +++ b/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Triangle_coordinates_2.h @@ -49,7 +49,7 @@ namespace Barycentric_coordinates { // [1] Reference: Weisstein, Eric W. "Barycentric Coordinates." From MathWorld--A Wolfram Web Resource. http://mathworld.wolfram.com/BarycentricCoordinates.html. /*! - * \ingroup PkgBarycentric_coordinates_2 + * \ingroup PkgBarycentric_coordinates_2Ref * The class `Triangle_coordinates_2` implements barycentric coordinates ( [1], * [2] ) with respect to an arbitrary non-degenerate triangle in the plane. * This class is parameterized by a traits class `Traits`. diff --git a/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Wachspress_2.h b/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Wachspress_2.h index 09209606660..2f0775655ae 100644 --- a/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Wachspress_2.h +++ b/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Wachspress_2.h @@ -49,7 +49,7 @@ namespace Barycentric_coordinates { // [1] Reference: "M. S. Floater, K. Hormann, and G. Kos. A general construction of barycentric coordinates over convex polygons. Advances in Computational Mathematics, 24(1-4):311-331, 2006.". /*! - * \ingroup PkgBarycentric_coordinates_2 + * \ingroup PkgBarycentric_coordinates_2Ref * The class `Wachspress_2` implements 2D Wachspress coordinates ( \cite cgal:bc:fhk-gcbcocp-06, \cite cgal:bc:mlbd-gbcip-02, \cite cgal:bc:w-rfeb-75 ). * This class is parameterized by a traits class `Traits`, and it is used as a coordinate class to complete the class `Generalized_barycentric_coordinates_2`. * For a polygon with three vertices it is better to use the class `Triangle_coordinates_2`. diff --git a/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/barycentric_enum_2.h b/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/barycentric_enum_2.h index 3f8fe3541ca..eb8cad0a6af 100644 --- a/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/barycentric_enum_2.h +++ b/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/barycentric_enum_2.h @@ -32,7 +32,7 @@ namespace CGAL { /*! - * \ingroup PkgBarycentric_coordinates_2 + * \ingroup PkgBarycentric_coordinates_2Ref * The namespace Barycentric_coordinates contains implementations of all generalized barycentric coordinates: 2D, 3D, related enumerations, and so on. */ 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 4c918fffd2b..f22267db575 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 @@ -2,7 +2,7 @@ namespace CGAL { /*! \addtogroup boolean_complement Complement Functions -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref \anchor ref_bso_complement The `complement` function is overloaded. Depending on the @@ -58,7 +58,7 @@ namespace CGAL { /*! \addtogroup boolean_difference Difference Functions -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref \anchor ref_bso_difference Each one of these functions computes the difference between two given @@ -181,7 +181,7 @@ namespace CGAL { /*! \addtogroup boolean_do_intersect Intersection Testing Functions -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref \anchor ref_bso_do_intersect Each one of these functions computes if the interior of two given @@ -305,7 +305,7 @@ namespace CGAL { /*! \addtogroup boolean_intersection Intersection Functions -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref \anchor ref_bso_intersection Each one of these functions computes the intersection of two given @@ -467,7 +467,7 @@ namespace CGAL { /*! \addtogroup boolean_join Union Functions -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref \anchor ref_bso_union Each one of these functions computes the union of two given polygons @@ -621,7 +621,7 @@ OutputIterator oi); namespace CGAL { /*! \addtogroup boolean_oriented_side Oriented Side Functions -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref \anchor ref_bso_oriented_side Each one of these functions returns `ON_POSITIVE_SIDE` if the two @@ -706,7 +706,7 @@ namespace CGAL { /*! \addtogroup boolean_symmetric_difference Symmetric Difference Functions -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref \anchor ref_bso_symmetric_difference Each one of these functions computes the symmetric difference between diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Boolean_set_operations_2/Gps_default_dcel.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Boolean_set_operations_2/Gps_default_dcel.h index f15067d1cfb..a70de3fc84d 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Boolean_set_operations_2/Gps_default_dcel.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Boolean_set_operations_2/Gps_default_dcel.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref An instance of this template serves as a basis type for any face record of the Dcel class used by instances of the @@ -22,7 +22,7 @@ further. class Gps_face_base : public Arr_face_base {}; /*! -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref An instance of this teplate serves as a basis type for any halfedge record of the Dcel class used by instances of the @@ -44,7 +44,7 @@ class Gps_halfedge_base : public Arr_halfedge_base {}; /*! -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref The default Dcel class template used by the `General_polygon_set_2` and `General_polygon_with_holes_2` class templates. diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_2.h index 0eef1b3b4bf..9f1b175d383 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref The class `General_polygon_2` models the concept `GeneralPolygon_2`. It represents a simple general-polygon. It is parameterized with the type diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_set_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_set_2.h index fbaf40f38b8..c11787975f8 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_set_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_set_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref An object of the `General_polygon_set_2` class-template represents a point set in the plane bounded by \f$ x\f$ monotone curves. Points in the set diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_circle_segment_traits_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_circle_segment_traits_2.h index de13d563186..663c1d11a4c 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_circle_segment_traits_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_circle_segment_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref The traits class `Gps_circle_segment_traits_2` models the `GeneralPolygonSetTraits_2` concept. It enables Boolean set-operations on general polygons bounded by diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_segment_traits_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_segment_traits_2.h index adc2521cbfa..536b7dddd40 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_segment_traits_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_segment_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref \cgalModels `GeneralPolygonSetTraits_2` diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_traits_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_traits_2.h index cb5172cbf06..d5155423f8e 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_traits_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref The traits class `Gps_traits_2` models the concept `GeneralPolygonSetTraits_2`. It inherits from the instantiated diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Polygon_set_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Polygon_set_2.h index 1e9b5211e9a..3ed0e9cc728 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Polygon_set_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Polygon_set_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref The class `Polygon_set_2` represents sets of linear polygons with holes. The first two template parameters (`Kernel` and `Container`) diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/connect_holes.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/connect_holes.h index 939c8566e9f..928c0d1fc96 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/connect_holes.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/connect_holes.h @@ -2,7 +2,7 @@ namespace CGAL { /*! \addtogroup boolean_connect_holes Functions on Polygon with Holes -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref \anchor ref_bso_connect_holes diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/PackageDescription.txt b/Boolean_set_operations_2/doc/Boolean_set_operations_2/PackageDescription.txt index c9570ed6982..dab4b1e3c38 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/PackageDescription.txt +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/PackageDescription.txt @@ -1,20 +1,20 @@ -/// \defgroup PkgBooleanSetOperations2 2D Regularized Boolean Set-Operations Reference +/// \defgroup PkgBooleanSetOperations2Ref 2D Regularized Boolean Set-Operations Reference /// \defgroup PkgBooleanSetOperations2Concepts Concepts -/// \ingroup PkgBooleanSetOperations2 +/// \ingroup PkgBooleanSetOperations2Ref /// \cgalConceptNamespace /// The namespace containing concepts specific to 2D Boolean Set Operations. namespace ArrDirectionalTraits {} /*! -\addtogroup PkgBooleanSetOperations2 +\addtogroup PkgBooleanSetOperations2Ref \todo check generated documentation \cgalPkgDescriptionBegin{2D Regularized Boolean Set-Operations,PkgBooleanSetOperations2Summary} \cgalPkgPicture{Boolean_set_operations_2.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Efi Fogel, Ophir Setter, Ron Wein, Guy Zucker, Baruch Zukerman, and Dan Halperin} \cgalPkgDesc{This package consists of the implementation of Boolean set-operations on point sets bounded by weakly x-monotone curves in 2-dimensional Euclidean space. In particular, it contains the implementation of regularized Boolean set-operations, intersection predicates, and point containment predicates.} -\cgalPkgManuals{Chapter_2D_Regularized_Boolean_Set-Operations,PkgBooleanSetOperations2} +\cgalPkgManuals{Chapter_2D_Regularized_Boolean_Set-Operations,PkgBooleanSetOperations2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.2} diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d.h index 8fbe5d25734..c53940face3 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef An object of class `Approximate_min_ellipsoid_d` is an approximation to the ellipsoid of smallest volume enclosing a finite multiset of points diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_2.h index edd58cacab9..8692b24c19a 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The class `Approximate_min_ellipsoid_d_traits_2` is a traits class for `CGAL::Approximate_min_ellipsoid_d` using the diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_3.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_3.h index dd398e46456..b7f79cd4167 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_3.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The class `Approximate_min_ellipsoid_d_traits_3` is a traits class for `CGAL::Approximate_min_ellipsoid_d` using the diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_d.h index b7bdcbe586e..75d4b45137d 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_d.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The class `Approximate_min_ellipsoid_d_traits_d` is a traits class for `CGAL::Approximate_min_ellipsoid_d` using the diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_annulus_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_annulus_d.h index c7af75cd66f..fdcc62b8986 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_annulus_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_annulus_d.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef An object of the class `Min_annulus_d` is the unique annulus (region between two concentric spheres with radii \f$ r\f$ and \f$ R\f$, \f$ r \leq R\f$) enclosing a diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2.h index f4e8d622eb0..62309eefebe 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef An object of the class `Min_circle_2` is the unique circle of smallest area enclosing a finite (multi)set of points in two-dimensional Euclidean diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2_traits_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2_traits_2.h index acba791f7dc..3fe2037bdc2 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2_traits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The class `Min_circle_2_traits_2` is a traits class for `Min_circle_2` using the two-dimensional \cgal kernel. diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2.h index fc36ae9e095..a9edbb88bcd 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef An object of the class `Min_ellipse_2` is the unique ellipse of smallest area enclosing a finite (multi)set of points in two-dimensional euclidean diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2_traits_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2_traits_2.h index e6a1ec22a1e..3a1f2fd3e77 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2_traits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The class `Min_ellipse_2_traits_2` is a traits class for `CGAL::Min_ellipse_2` using the two-di-men-sional \cgal kernel. 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 6562281723e..212e5188ba2 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 @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The class `Min_quadrilateral_default_traits_2` is a traits class for the functions `min_rectangle_2`, `min_parallelogram_2` and diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_2.h index d0806b47f50..9d0e4de3c88 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The class `Min_sphere_annulus_d_traits_2` is a traits class for the \f$ d\f$-dimensional optimisation algorithms using the two-dimensional \cgal kernel. diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_3.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_3.h index e4627f99380..6d07f070b9e 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_3.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The class `Min_sphere_annulus_d_traits_3` is a traits class for the \f$ d\f$-dimensional optimisation algorithms using the three-dimensional \cgal kernel. diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_d.h index 5fec804b71d..0e65c594f65 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_d.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The class `Min_sphere_annulus_d_traits_d` is a traits class for the \f$ d\f$-dimensional optimisation algorithms using the \f$ d\f$-dimensional \cgal kernel. diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_d.h index 7c93a00b5e1..a682dd41650 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_d.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef An object of the class `Min_sphere_d` is the unique sphere of smallest volume enclosing a finite (multi)set of points in \f$ d\f$-dimensional diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_2.h index 778ee39f84d..5b5f00fc91f 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The class `Min_sphere_of_points_d_traits_2` is a diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_3.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_3.h index 94fc8752a01..0a789e04e45 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_3.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The class `Min_sphere_of_points_d_traits_3` is a diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_d.h index 20af328cf96..2fa016f2303 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_d.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The class `Min_sphere_of_points_d_traits_d` is diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d.h index 24de9ca7fd8..f7cb4a140ca 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef An object of the class `Min_sphere_of_spheres_d` is a data structure that represents the unique sphere of smallest volume enclosing a finite set of spheres diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_2.h index 6154e5dae39..a0e085ede92 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The class `Min_sphere_of_spheres_d_traits_2` is a diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_3.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_3.h index b59539673e6..e366016a9e0 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_3.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The class `Min_sphere_of_spheres_d_traits_3` is a diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_d.h index 81774e86735..6821e1e210c 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_d.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The class `Min_sphere_of_spheres_d_traits_d` is 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 84ce8286486..c9c0f1469ae 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/min_quadrilateral_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/min_quadrilateral_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The function computes a minimum area enclosing parallelogram \f$ A(P)\f$ of a given convex point set \f$ P\f$. Note that @@ -72,7 +72,7 @@ Traits& t = Default_traits); namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The function computes a minimum area enclosing rectangle \f$ R(P)\f$ of a given convex point set \f$ P\f$. Note that \f$ R(P)\f$ is not @@ -141,7 +141,7 @@ Traits& t = Default_traits); namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The function computes a minimum width enclosing strip \f$ S(P)\f$ of a given convex point set \f$ P\f$. A strip is the closed region 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 debd0c3c8ea..77381b0cb91 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 @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The class `Rectangular_p_center_default_traits_2` defines types and operations needed to compute rectilinear \f$ p\f$-centers of a planar point set @@ -194,7 +194,7 @@ construct_iso_rectangle_2_above_right_point_2_object() const; }; /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef Computes rectilinear \f$ p\f$-centers of a planar point set, i.e.\ a set of \f$ p\f$ points such diff --git a/Bounding_volumes/doc/Bounding_volumes/PackageDescription.txt b/Bounding_volumes/doc/Bounding_volumes/PackageDescription.txt index 30b90996b35..3dea01a9475 100644 --- a/Bounding_volumes/doc/Bounding_volumes/PackageDescription.txt +++ b/Bounding_volumes/doc/Bounding_volumes/PackageDescription.txt @@ -1,15 +1,15 @@ -/// \defgroup PkgBoundingVolumes Bounding Volumes Reference +/// \defgroup PkgBoundingVolumesRef Bounding Volumes Reference /// \defgroup PkgBoundingVolumesConcepts Concepts -/// \ingroup PkgBoundingVolumes +/// \ingroup PkgBoundingVolumesRef /*! -\addtogroup PkgBoundingVolumes +\addtogroup PkgBoundingVolumesRef \todo check generated documentation \cgalPkgDescriptionBegin{Bounding Volumes,PkgBoundingVolumesSummary} \cgalPkgPicture{minCircle.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Kaspar Fischer, Bernd Gärtner, Thomas Herrmann, Michael Hoffmann, and Sven Schönherr} \cgalPkgDesc{This package provides algorithms for computing optimal bounding volumes of point sets. In d-dimensional space, the smallest enclosing sphere, ellipsoid (approximate), and annulus can be computed. In 3-dimensional space, the smallest enclosing strip is available as well, and in 2-dimensional space, there are algorithms for a number of additional volumes (rectangles, parallelograms, \f$ k=2,3,4\f$ axis-aligned rectangles). The smallest enclosing sphere algorithm can also be applied to a set of d-dimensional spheres.} -\cgalPkgManuals{Chapter_Bounding_Volumes,PkgBoundingVolumes} +\cgalPkgManuals{Chapter_Bounding_Volumes,PkgBoundingVolumesRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{1.1} diff --git a/Box_intersection_d/doc/Box_intersection_d/PackageDescription.txt b/Box_intersection_d/doc/Box_intersection_d/PackageDescription.txt index 272c41c14d5..86ffd51bf38 100644 --- a/Box_intersection_d/doc/Box_intersection_d/PackageDescription.txt +++ b/Box_intersection_d/doc/Box_intersection_d/PackageDescription.txt @@ -1,24 +1,24 @@ -/// \defgroup PkgBoxIntersectionD Intersecting Sequences of dD Iso-oriented Boxes Reference +/// \defgroup PkgBoxIntersectionDRef Intersecting Sequences of dD Iso-oriented Boxes Reference /// \defgroup PkgBoxIntersectionDConcepts Concepts -/// \ingroup PkgBoxIntersectionD +/// \ingroup PkgBoxIntersectionDRef /// \defgroup PkgBoxIntersectionDClasses Classes -/// \ingroup PkgBoxIntersectionD +/// \ingroup PkgBoxIntersectionDRef /// \defgroup PkgBoxIntersectionD_box_intersection_d CGAL::box_intersection_d() -/// \ingroup PkgBoxIntersectionD +/// \ingroup PkgBoxIntersectionDRef /// \defgroup PkgBoxIntersectionD_box_intersection_all_pairs_d CGAL::box_intersection_all_pairs_d() -/// \ingroup PkgBoxIntersectionD +/// \ingroup PkgBoxIntersectionDRef /// \defgroup PkgBoxIntersectionD_box_self_intersection_d CGAL::box_self_intersection_d() -/// \ingroup PkgBoxIntersectionD +/// \ingroup PkgBoxIntersectionDRef /// \defgroup PkgBoxIntersectionD_box_self_intersection_all_pairs_d CGAL::box_self_intersection_all_pairs_d() -/// \ingroup PkgBoxIntersectionD +/// \ingroup PkgBoxIntersectionDRef /*! -\addtogroup PkgBoxIntersectionD +\addtogroup PkgBoxIntersectionDRef \todo de-math and change D to d for the dimension @@ -27,7 +27,7 @@ \cgalPkgSummaryBegin \cgalPkgAuthors{Lutz Kettner, Andreas Meyer, and Afra Zomorodian} \cgalPkgDesc{An efficient algorithm for finding all intersecting pairs for large numbers of iso-oriented boxes, in order to apply a user defined callback on them. Typically these boxes will be bounding boxes of more complicated geometries. The algorithm is useful for (self-) intersection tests of surfaces etc. } -\cgalPkgManuals{Chapter_Intersecting_Sequences_of_dD_Iso-oriented_Boxes,PkgBoxIntersectionD} +\cgalPkgManuals{Chapter_Intersecting_Sequences_of_dD_Iso-oriented_Boxes,PkgBoxIntersectionDRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.1} diff --git a/CGAL_ipelets/doc/CGAL_ipelets/CGAL/CGAL_Ipelet_base.h b/CGAL_ipelets/doc/CGAL_ipelets/CGAL/CGAL_Ipelet_base.h index 32c46524737..5152f1a50a2 100644 --- a/CGAL_ipelets/doc/CGAL_ipelets/CGAL/CGAL_Ipelet_base.h +++ b/CGAL_ipelets/doc/CGAL_ipelets/CGAL/CGAL_Ipelet_base.h @@ -1,5 +1,5 @@ /*! -\ingroup PkgCGALIpelets +\ingroup PkgCGALIpeletsRef The registration of a new ipelet can be done using the macro command `CGAL_IPELET`. Taking as a parameter the name of the class defining the new ipelet, that macro must be placed in the source file after the class definition. @@ -9,7 +9,7 @@ file after the class definition. namespace CGAL { /*! -\ingroup PkgCGALIpelets +\ingroup PkgCGALIpeletsRef `Ipelet_base` is an abstract base class for defining an ipelet. The only function that needs to be defined in a derived class is diff --git a/CGAL_ipelets/doc/CGAL_ipelets/PackageDescription.txt b/CGAL_ipelets/doc/CGAL_ipelets/PackageDescription.txt index d51312d18c2..fc2d23952be 100644 --- a/CGAL_ipelets/doc/CGAL_ipelets/PackageDescription.txt +++ b/CGAL_ipelets/doc/CGAL_ipelets/PackageDescription.txt @@ -1,12 +1,12 @@ -/// \defgroup PkgCGALIpelets CGAL Ipelets Reference +/// \defgroup PkgCGALIpeletsRef CGAL Ipelets Reference /*! -\addtogroup PkgCGALIpelets +\addtogroup PkgCGALIpeletsRef \cgalPkgDescriptionBegin{CGAL Ipelets,PkgCGALIpeletsSummary} \cgalPkgPicture{ipeico.jpg} \cgalPkgSummaryBegin \cgalPkgAuthors{Olivier Devillers, Sébastien Loriot, and Sylvain Pion} \cgalPkgDesc{This package provides a generic framework to easily write ipelets (plug-in's) using \cgal for the the Ipe extensible drawing editor.} -\cgalPkgManuals{Chapter_CGAL_Ipelets,PkgCGALIpelets} +\cgalPkgManuals{Chapter_CGAL_Ipelets,PkgCGALIpeletsRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.5} diff --git a/Circular_kernel_2/doc/Circular_kernel_2/PackageDescription.txt b/Circular_kernel_2/doc/Circular_kernel_2/PackageDescription.txt index 5343842eb4a..e23a47c2269 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/PackageDescription.txt +++ b/Circular_kernel_2/doc/Circular_kernel_2/PackageDescription.txt @@ -1,34 +1,34 @@ -/// \defgroup PkgCircularKernel2 2D Circular Geometry Kernel Reference +/// \defgroup PkgCircularKernel2Ref 2D Circular Geometry Kernel Reference /// \defgroup PkgCircularKernel2GeometricConcepts Geometric Concepts -/// \ingroup PkgCircularKernel2 +/// \ingroup PkgCircularKernel2Ref /// \defgroup PkgCircularKernel2GeometricClasses Geometric Kernel and Classes -/// \ingroup PkgCircularKernel2 +/// \ingroup PkgCircularKernel2Ref /// \defgroup PkgCircularKernel2GeometricFunctions Geometric Global Functions -/// \ingroup PkgCircularKernel2 +/// \ingroup PkgCircularKernel2Ref /// \defgroup PkgCircularKernel2AlgebraicConcepts Algebraic Concepts -/// \ingroup PkgCircularKernel2 +/// \ingroup PkgCircularKernel2Ref /// \defgroup PkgCircularKernel2AlgebraicClasses Algebraic Kernel and Classes -/// \ingroup PkgCircularKernel2 +/// \ingroup PkgCircularKernel2Ref /*! -\addtogroup PkgCircularKernel2 +\addtogroup PkgCircularKernel2Ref \todo check generated documentation \cgalPkgDescriptionBegin{2D Circular Geometry Kernel,PkgCircularKernel2Summary} \cgalPkgPicture{Boolean_operation_detail.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Pedro Machado Manhães de Castro, Sylvain Pion, and Monique Teillaud} \cgalPkgDesc{This package is an extension of the linear \cgal kernel. It offers functionalities on circles, circular arcs and line segments in the plane. } -\cgalPkgManuals{Chapter_2D_Circular_Geometry_Kernel,PkgCircularKernel2} +\cgalPkgManuals{Chapter_2D_Circular_Geometry_Kernel,PkgCircularKernel2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.2} diff --git a/Circular_kernel_3/doc/Circular_kernel_3/PackageDescription.txt b/Circular_kernel_3/doc/Circular_kernel_3/PackageDescription.txt index 5b04d8f987e..41460181e1c 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/PackageDescription.txt +++ b/Circular_kernel_3/doc/Circular_kernel_3/PackageDescription.txt @@ -1,31 +1,31 @@ -/// \defgroup PkgSphericalKernel3 3D Spherical Geometry Kernel Reference +/// \defgroup PkgSphericalKernel3Ref 3D Spherical Geometry Kernel Reference /// \defgroup PkgSphericalKernel3GeometricConcepts Geometric Concepts -/// \ingroup PkgSphericalKernel3 +/// \ingroup PkgSphericalKernel3Ref /// \defgroup PkgSphericalKernel3GeometricClasses Geometric Kernel and Classes -/// \ingroup PkgSphericalKernel3 +/// \ingroup PkgSphericalKernel3Ref /// \defgroup PkgSphericalKernel3GeometricFunctions Geometric Global Functions -/// \ingroup PkgSphericalKernel3 +/// \ingroup PkgSphericalKernel3Ref /// \defgroup PkgSphericalKernel3AlgebraicConcepts Algebraic Concepts -/// \ingroup PkgSphericalKernel3 +/// \ingroup PkgSphericalKernel3Ref /// \defgroup PkgSphericalKernel3AlgebraicClasses Algebraic Kernel and Classes -/// \ingroup PkgSphericalKernel3 +/// \ingroup PkgSphericalKernel3Ref /*! -\addtogroup PkgSphericalKernel3 +\addtogroup PkgSphericalKernel3Ref \cgalPkgDescriptionBegin{3D Spherical Geometry Kernel,PkgSphericalKernel3Summary} \cgalPkgPicture{segment_sphere_intersection_detail.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Pedro Machado Manhães de Castro, Frédéric Cazals, Sébastien Loriot, and Monique Teillaud} \cgalPkgDesc{This package is an extension of the linear \cgal %Kernel. It offers functionalities on spheres, circles, circular arcs and line segments, in the 3D space or restricted on a reference sphere.} -\cgalPkgManuals{Chapter_3D_Spherical_Geometry_Kernel,PkgSphericalKernel3} +\cgalPkgManuals{Chapter_3D_Spherical_Geometry_Kernel,PkgSphericalKernel3Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.4} diff --git a/Circulator/doc/Circulator/CGAL/circulator.h b/Circulator/doc/Circulator/CGAL/circulator.h index d081d150af8..7a8cb8551ba 100644 --- a/Circulator/doc/Circulator/CGAL/circulator.h +++ b/Circulator/doc/Circulator/CGAL/circulator.h @@ -295,7 +295,7 @@ template C::size_type circulator_size(C c); namespace CGAL { /*! -\ingroup PkgHandlesAndCirculators +\ingroup PkgHandlesAndCirculatorsRef The circulator traits class distinguishes between circulators and iterators. It defines a local type `category` that is identical to the diff --git a/Circulator/doc/Circulator/PackageDescription.txt b/Circulator/doc/Circulator/PackageDescription.txt index f9141bf7c52..8e24e577d06 100644 --- a/Circulator/doc/Circulator/PackageDescription.txt +++ b/Circulator/doc/Circulator/PackageDescription.txt @@ -1,33 +1,33 @@ -/// \defgroup PkgHandlesAndCirculators Handles and Circulators Reference +/// \defgroup PkgHandlesAndCirculatorsRef Handles and Circulators Reference /// \defgroup PkgHandlesAndCirculatorsConcepts Concepts -/// \ingroup PkgHandlesAndCirculators +/// \ingroup PkgHandlesAndCirculatorsRef /// \defgroup PkgHandlesAndCirculatorsAdapter Adapters for Iterators and Containers -/// \ingroup PkgHandlesAndCirculators +/// \ingroup PkgHandlesAndCirculatorsRef /// \defgroup PkgHandlesAndCirculatorsFunctions Functions -/// \ingroup PkgHandlesAndCirculators +/// \ingroup PkgHandlesAndCirculatorsRef /// \defgroup PkgHandlesAndCirculatorsTags Compile Time Tags -/// \ingroup PkgHandlesAndCirculators +/// \ingroup PkgHandlesAndCirculatorsRef /// \defgroup PkgHandlesAndCirculatorsAssert Assertions -/// \ingroup PkgHandlesAndCirculators +/// \ingroup PkgHandlesAndCirculatorsRef /// \defgroup PkgHandlesAndCirculatorsBaseClasses Base Classes -/// \ingroup PkgHandlesAndCirculators +/// \ingroup PkgHandlesAndCirculatorsRef /*! -\addtogroup PkgHandlesAndCirculators +\addtogroup PkgHandlesAndCirculatorsRef \cgalPkgDescriptionBegin{Handles and Circulators,PkgHandlesAndCirculatorsSummary} \cgalPkgPicture{circulator.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Olivier Devillers, Lutz Kettner, Sylvain Pion, Michael Seel, and Mariette Yvinec} \cgalPkgDesc{This package descibes handles and circulators. They are related to iterators. Handles allow to dereference but neither to increment nor to decrement. Circulators have no notion of past-the-end, and they are used in \cgal whenever we have cyclic stuctures. } -\cgalPkgManuals{Chapter_Handles_Ranges_and_Circulators,PkgHandlesAndCirculators} +\cgalPkgManuals{Chapter_Handles_Ranges_and_Circulators,PkgHandlesAndCirculatorsRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{1.0} diff --git a/Classification/doc/Classification/PackageDescription.txt b/Classification/doc/Classification/PackageDescription.txt index 28404554d77..1c44376765e 100644 --- a/Classification/doc/Classification/PackageDescription.txt +++ b/Classification/doc/Classification/PackageDescription.txt @@ -1,55 +1,55 @@ /*! -\defgroup PkgClassification Classification Reference +\defgroup PkgClassificationRef Classification Reference \defgroup PkgClassificationConcepts Concepts -\ingroup PkgClassification +\ingroup PkgClassificationRef \defgroup PkgClassificationMain Main Functions -\ingroup PkgClassification +\ingroup PkgClassificationRef Functions that perform classification based on a set of labels and a classifier, with or without regularization. \defgroup PkgClassificationClassifiers Classifiers -\ingroup PkgClassification +\ingroup PkgClassificationRef Classifiers are functors that, given a label set and an input item, associate this input item with an energy for each label. This energy measures the likelihood of the item to belong to this label. \defgroup PkgClassificationDataStructures Common Data Structures -\ingroup PkgClassification +\ingroup PkgClassificationRef Useful data structures that are used to compute features (computation of eigenvalues, for example). \defgroup PkgClassificationLabel Label -\ingroup PkgClassification +\ingroup PkgClassificationRef A label represents how an item should be classified, for example: _vegetation_, _building_, _road_, etc. \defgroup PkgClassificationFeature Feature -\ingroup PkgClassification +\ingroup PkgClassificationRef Features are defined as scalar fields that associates each input item with a specific value. \defgroup PkgClassificationFeatures Predefined Features -\ingroup PkgClassification +\ingroup PkgClassificationRef \cgal provides some predefined features that are relevant for classification of point sets. \defgroup PkgClassificationPointSet Point Set Classification -\ingroup PkgClassification +\ingroup PkgClassificationRef Data structures specialized to classify point sets. \defgroup PkgClassificationMesh Mesh Classification -\ingroup PkgClassification +\ingroup PkgClassificationRef Data structures specialized to classify surface meshes. \defgroup PkgClassificationCluster Cluster Classification -\ingroup PkgClassification +\ingroup PkgClassificationRef Data structures specialized to classify clusters. -\addtogroup PkgClassification +\addtogroup PkgClassificationRef \cgalPkgDescriptionBegin{Classification, PkgClassificationSummary} \cgalPkgPicture{data_classif.png} @@ -57,7 +57,7 @@ Data structures specialized to classify clusters. \cgalPkgSummaryBegin \cgalPkgAuthors{Simon Giraudot, Florent Lafarge} \cgalPkgDesc{This component implements an algorithm that classifies a data set into a user-defined set of labels (such as ground, vegetation, buildings, etc.). A flexible API is provided so that users can classify any type of data, compute their own local features on the input data set, and define their own labels.} -\cgalPkgManuals{Chapter_Classification, PkgClassification} +\cgalPkgManuals{Chapter_Classification, PkgClassificationRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin diff --git a/Combinatorial_map/doc/Combinatorial_map/PackageDescription.txt b/Combinatorial_map/doc/Combinatorial_map/PackageDescription.txt index 9dbdd2feb72..4a80ea30312 100644 --- a/Combinatorial_map/doc/Combinatorial_map/PackageDescription.txt +++ b/Combinatorial_map/doc/Combinatorial_map/PackageDescription.txt @@ -1,10 +1,10 @@ -/// \defgroup PkgCombinatorialMaps Combinatorial Maps Reference +/// \defgroup PkgCombinatorialMapsRef Combinatorial Maps Reference /// \defgroup PkgCombinatorialMapsConcepts Concepts -/// \ingroup PkgCombinatorialMaps +/// \ingroup PkgCombinatorialMapsRef /// \defgroup PkgCombinatorialMapsClasses Classes -/// \ingroup PkgCombinatorialMaps +/// \ingroup PkgCombinatorialMapsRef /*! Basic constructions. \code @@ -12,7 +12,7 @@ \endcode */ /// \defgroup PkgCombinatorialMapsConstructions Constructions -/// \ingroup PkgCombinatorialMaps +/// \ingroup PkgCombinatorialMapsRef /*! High-level operations. \code @@ -20,17 +20,17 @@ \endcode */ /// \defgroup PkgCombinatorialMapsOperations Operations -/// \ingroup PkgCombinatorialMaps +/// \ingroup PkgCombinatorialMapsRef /*! -\addtogroup PkgCombinatorialMaps +\addtogroup PkgCombinatorialMapsRef \cgalPkgDescriptionBegin{Combinatorial Maps,PkgCombinatorialMapsSummary} \cgalPkgPicture{cmap_logo.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Guillaume Damiand} \cgalPkgDesc{This package implements Combinatorial Maps in d dimensions. A combinatorial map is a data structure enabling to represent an orientable subdivided object by describing all the cells of the subdivision (for example in 3D vertices, edges, faces, volumes) and all the incidence and adjacency relationships between these cells. Information can be associated to cells thanks to attributes. In 2D, a combinatorial map is equivalent to a halfedge data structure. The package provides basic creation, modification operations, and several iterators enabling to run through some specific part of the object.} -\cgalPkgManuals{Chapter_Combinatorial_Maps,PkgCombinatorialMaps} +\cgalPkgManuals{Chapter_Combinatorial_Maps,PkgCombinatorialMapsRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.9} diff --git a/Cone_spanners_2/doc/Cone_spanners_2/PackageDescription.txt b/Cone_spanners_2/doc/Cone_spanners_2/PackageDescription.txt index f0258b35140..6c2e45d11d1 100644 --- a/Cone_spanners_2/doc/Cone_spanners_2/PackageDescription.txt +++ b/Cone_spanners_2/doc/Cone_spanners_2/PackageDescription.txt @@ -1,9 +1,9 @@ // PRETTY PACKAGE NAME should equal the project title in Doxyfile.in -/// \defgroup PkgConeBasedSpanners Cone-Based Spanners Reference +/// \defgroup PkgConeBasedSpannersRef Cone-Based Spanners Reference /*! -\addtogroup PkgConeBasedSpanners +\addtogroup PkgConeBasedSpannersRef \cgalPkgDescriptionBegin{Cone-Based Spanners,PkgConeBasedSpannersSummary} \cgalPkgPicture{Logo-ConeSpanners.png} @@ -20,7 +20,7 @@ value defined in \cgal, which is still accurate enough for most applications. Moreover, for visualization purpose, this package provides a global function to generate the data and script files used by Gnuplot to plot the constructed graphs. This package also provides options for the Half Yao graph and the Half Theta graph.} -\cgalPkgManuals{Chapter_ConeBasedSpanners,PkgConeBasedSpanners} +\cgalPkgManuals{Chapter_ConeBasedSpanners,PkgConeBasedSpannersRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin diff --git a/Cone_spanners_2/include/CGAL/Compute_cone_boundaries_2.h b/Cone_spanners_2/include/CGAL/Compute_cone_boundaries_2.h index 19b61beaf66..2aead7db074 100644 --- a/Cone_spanners_2/include/CGAL/Compute_cone_boundaries_2.h +++ b/Cone_spanners_2/include/CGAL/Compute_cone_boundaries_2.h @@ -44,7 +44,7 @@ namespace CGAL { -/*! \ingroup PkgConeBasedSpanners +/*! \ingroup PkgConeBasedSpannersRef * * \brief The functor for computing the directions of cone boundaries with a given * cone number and a given initial direction. diff --git a/Cone_spanners_2/include/CGAL/Cone_spanners_enum_2.h b/Cone_spanners_2/include/CGAL/Cone_spanners_enum_2.h index 7f7832bfd43..29f37170519 100644 --- a/Cone_spanners_2/include/CGAL/Cone_spanners_enum_2.h +++ b/Cone_spanners_2/include/CGAL/Cone_spanners_enum_2.h @@ -31,7 +31,7 @@ namespace CGAL { - /*! \ingroup PkgConeBasedSpanners + /*! \ingroup PkgConeBasedSpannersRef \brief An enum of the choice of cones in cone spanners. */ diff --git a/Cone_spanners_2/include/CGAL/Construct_theta_graph_2.h b/Cone_spanners_2/include/CGAL/Construct_theta_graph_2.h index 156d5b3e151..313630607ba 100644 --- a/Cone_spanners_2/include/CGAL/Construct_theta_graph_2.h +++ b/Cone_spanners_2/include/CGAL/Construct_theta_graph_2.h @@ -45,7 +45,7 @@ namespace CGAL { -/*! \ingroup PkgConeBasedSpanners +/*! \ingroup PkgConeBasedSpannersRef \brief A template functor for constructing Theta graphs with a given set of 2D points and a given initial direction for the cone boundaries. diff --git a/Cone_spanners_2/include/CGAL/Construct_yao_graph_2.h b/Cone_spanners_2/include/CGAL/Construct_yao_graph_2.h index 621ce9011a6..e9701cbe9d7 100644 --- a/Cone_spanners_2/include/CGAL/Construct_yao_graph_2.h +++ b/Cone_spanners_2/include/CGAL/Construct_yao_graph_2.h @@ -42,7 +42,7 @@ namespace CGAL { -/*! \ingroup PkgConeBasedSpanners +/*! \ingroup PkgConeBasedSpannersRef \brief A template functor for constructing Yao graphs with a given set of 2D points and a given initial direction for the cone boundaries. diff --git a/Cone_spanners_2/include/CGAL/gnuplot_output_2.h b/Cone_spanners_2/include/CGAL/gnuplot_output_2.h index 95ec96f016b..177c0b6e350 100644 --- a/Cone_spanners_2/include/CGAL/gnuplot_output_2.h +++ b/Cone_spanners_2/include/CGAL/gnuplot_output_2.h @@ -46,7 +46,7 @@ namespace CGAL { /* ------ Declarations go first, then implementations follow. ------ */ /*! -* \ingroup PkgConeBasedSpanners +* \ingroup PkgConeBasedSpannersRef * \brief Output a set of files used by Gnuplot to plot `g`. * * The files that are generated for Gnuplot are: diff --git a/Convex_decomposition_3/doc/Convex_decomposition_3/PackageDescription.txt b/Convex_decomposition_3/doc/Convex_decomposition_3/PackageDescription.txt index e572fe2a1be..d2d4c0dbbbc 100644 --- a/Convex_decomposition_3/doc/Convex_decomposition_3/PackageDescription.txt +++ b/Convex_decomposition_3/doc/Convex_decomposition_3/PackageDescription.txt @@ -1,13 +1,13 @@ -/// \defgroup PkgConvexDecomposition3 Convex Decomposition of Polyhedra Reference +/// \defgroup PkgConvexDecomposition3Ref Convex Decomposition of Polyhedra Reference /*! -\addtogroup PkgConvexDecomposition3 +\addtogroup PkgConvexDecomposition3Ref \cgalPkgDescriptionBegin{Convex Decomposition of Polyhedra,PkgConvexDecomposition3Summary} \cgalPkgPicture{Convex_decomposition_3/fig/Convex_decomposition_3-teaser.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Peter Hachenberger} \cgalPkgDesc{This packages provides a function for decomposing a bounded polyhedron into convex sub-polyhedra. The decomposition yields \f$ O(r^2)\f$ convex pieces, where \f$ r\f$ is the number of edges, whose adjacent facets form an angle of more than 180 degrees with respect to the polyhedron's interior. This bound is worst-case optimal. } -\cgalPkgManuals{Chapter_Convex_Decomposition_of_Polyhedra,PkgConvexDecomposition3} +\cgalPkgManuals{Chapter_Convex_Decomposition_of_Polyhedra,PkgConvexDecomposition3Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.5} diff --git a/Convex_decomposition_3/include/CGAL/convex_decomposition_3.h b/Convex_decomposition_3/include/CGAL/convex_decomposition_3.h index f232603ff8f..45ae44ca0f7 100644 --- a/Convex_decomposition_3/include/CGAL/convex_decomposition_3.h +++ b/Convex_decomposition_3/include/CGAL/convex_decomposition_3.h @@ -44,7 +44,7 @@ namespace CGAL { /*! -\ingroup PkgConvexDecomposition3 +\ingroup PkgConvexDecomposition3Ref The function `convex_decomposition_3()` inserts additional facets into the given `Nef_polyhedron_3` `N`, such that each bounded diff --git a/Convex_hull_2/doc/Convex_hull_2/PackageDescription.txt b/Convex_hull_2/doc/Convex_hull_2/PackageDescription.txt index e27762884c3..1979658b512 100644 --- a/Convex_hull_2/doc/Convex_hull_2/PackageDescription.txt +++ b/Convex_hull_2/doc/Convex_hull_2/PackageDescription.txt @@ -1,32 +1,32 @@ -/// \defgroup PkgConvexHull2 2D Convex Hulls and Extreme Points Reference +/// \defgroup PkgConvexHull2Ref 2D Convex Hulls and Extreme Points Reference /// \defgroup PkgConvexHull2Concepts Concepts -/// \ingroup PkgConvexHull2 +/// \ingroup PkgConvexHull2Ref /// \defgroup PkgConvexHull2Traits Traits Classes -/// \ingroup PkgConvexHull2 +/// \ingroup PkgConvexHull2Ref /// \defgroup PkgConvexHull2Functions Convex Hull Functions -/// \ingroup PkgConvexHull2 +/// \ingroup PkgConvexHull2Ref /// \defgroup PkgConvexHull2Convexity Convexity Checking -/// \ingroup PkgConvexHull2 +/// \ingroup PkgConvexHull2Ref /// \defgroup PkgConvexHull2Subsequence Hull Subsequence Functions -/// \ingroup PkgConvexHull2 +/// \ingroup PkgConvexHull2Ref /// \defgroup PkgConvexHull2Extreme Extreme Point Functions -/// \ingroup PkgConvexHull2 +/// \ingroup PkgConvexHull2Ref /*! -\addtogroup PkgConvexHull2 +\addtogroup PkgConvexHull2Ref \cgalPkgDescriptionBegin{2D Convex Hulls and Extreme Points,PkgConvexHull2Summary} \cgalPkgPicture{Convex_hull_2/fig/convex_hull.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Susan Hert and Stefan Schirra} \cgalPkgDesc{This package provides functions for computing convex hulls in two dimensions as well as functions for checking if sets of points are strongly convex are not. There are also a number of functions described for computing particular extreme points and subsequences of hull points, such as the lower and upper hull of a set of points.} -\cgalPkgManuals{Chapter_2D_Convex_Hulls_and_Extreme_Points,PkgConvexHull2} +\cgalPkgManuals{Chapter_2D_Convex_Hulls_and_Extreme_Points,PkgConvexHull2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{1.0} diff --git a/Convex_hull_3/doc/Convex_hull_3/PackageDescription.txt b/Convex_hull_3/doc/Convex_hull_3/PackageDescription.txt index 9f0636fa1e3..413d01009b7 100644 --- a/Convex_hull_3/doc/Convex_hull_3/PackageDescription.txt +++ b/Convex_hull_3/doc/Convex_hull_3/PackageDescription.txt @@ -1,13 +1,13 @@ -/// \defgroup PkgConvexHull3 3D Convex Hulls Reference +/// \defgroup PkgConvexHull3Ref 3D Convex Hulls Reference /// \defgroup PkgConvexHull3Concepts Concepts -/// \ingroup PkgConvexHull3 +/// \ingroup PkgConvexHull3Ref /// \defgroup PkgConvexHull3Traits Traits Classes -/// \ingroup PkgConvexHull3 +/// \ingroup PkgConvexHull3Ref /*! \defgroup PkgConvexHull3Functions Convex Hull Functions - \ingroup PkgConvexHull3 + \ingroup PkgConvexHull3Ref The function `convex_hull_3()` computes the convex hull of a given set of three-dimensional points. @@ -17,10 +17,10 @@ degenerate hull may also be possible. */ /// \defgroup PkgConvexityChecking Convexity Checking -/// \ingroup PkgConvexHull3 +/// \ingroup PkgConvexHull3Ref /*! -\addtogroup PkgConvexHull3 +\addtogroup PkgConvexHull3Ref \todo fix or keep the `Default_traits` \cgalPkgDescriptionBegin{3D Convex Hulls,PkgConvexHull3Summary} @@ -28,7 +28,7 @@ degenerate hull may also be possible. \cgalPkgSummaryBegin \cgalPkgAuthors{Susan Hert and Stefan Schirra} \cgalPkgDesc{This package provides functions for computing convex hulls in three dimensions as well as functions for checking if sets of points are strongly convex or not. One can compute the convex hull of a set of points in three dimensions in two ways: using a static algorithm or using a triangulation to get a fully dynamic computation.} -\cgalPkgManuals{Chapter_3D_Convex_Hulls,PkgConvexHull3} +\cgalPkgManuals{Chapter_3D_Convex_Hulls,PkgConvexHull3Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{1.1} diff --git a/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d.h b/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d.h index ec21aaa1d83..abf6ea4b567 100644 --- a/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d.h +++ b/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgConvexHullD +\ingroup PkgConvexHullDRef \deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulationsSummary should be used instead. diff --git a/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d_traits_3.h b/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d_traits_3.h index 3719f9fc270..5c533959ebc 100644 --- a/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d_traits_3.h +++ b/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d_traits_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgConvexHullD +\ingroup PkgConvexHullDRef \deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulationsSummary should be used instead. diff --git a/Convex_hull_d/doc/Convex_hull_d/CGAL/Delaunay_d.h b/Convex_hull_d/doc/Convex_hull_d/CGAL/Delaunay_d.h index eb83d360fb8..1d31f4bc46c 100644 --- a/Convex_hull_d/doc/Convex_hull_d/CGAL/Delaunay_d.h +++ b/Convex_hull_d/doc/Convex_hull_d/CGAL/Delaunay_d.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgConvexHullD +\ingroup PkgConvexHullDRef \deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulationsSummary should be used instead. diff --git a/Convex_hull_d/doc/Convex_hull_d/PackageDescription.txt b/Convex_hull_d/doc/Convex_hull_d/PackageDescription.txt index b0a8e105d97..a15a32b6ac6 100644 --- a/Convex_hull_d/doc/Convex_hull_d/PackageDescription.txt +++ b/Convex_hull_d/doc/Convex_hull_d/PackageDescription.txt @@ -1,15 +1,15 @@ -/// \defgroup PkgConvexHullD dD Convex Hulls and Delaunay Triangulations Reference +/// \defgroup PkgConvexHullDRef dD Convex Hulls and Delaunay Triangulations Reference /// \defgroup PkgConvexHullDConcepts Concepts -/// \ingroup PkgConvexHullD +/// \ingroup PkgConvexHullDRef /*! -\addtogroup PkgConvexHullD +\addtogroup PkgConvexHullDRef \todo check generated documentation \cgalPkgDescriptionBegin{dD Convex Hulls and Delaunay Triangulations,PkgConvexHullDSummary} \cgalPkgPicture{convex_hull_d-teaser.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Susan Hert and Michael Seel} \cgalPkgDesc{This package provides functions for computing convex hulls and Delaunay triangulations in \f$ d\f$-dimensional Euclidean space.} -\cgalPkgManuals{Chapter_dD_Convex_Hulls_and_Delaunay_Triangulations,PkgConvexHullD} +\cgalPkgManuals{Chapter_dD_Convex_Hulls_and_Delaunay_Triangulations,PkgConvexHullDRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{2.3} diff --git a/Documentation/doc/Documentation/Installation.txt b/Documentation/doc/Documentation/Installation.txt index 20354fe18c6..86ec4c3933b 100644 --- a/Documentation/doc/Documentation/Installation.txt +++ b/Documentation/doc/Documentation/Installation.txt @@ -439,7 +439,7 @@ of \sc{Gmp} and \sc{Mpfr}, which can be downloaded with the installer \sc{zlib} is a data compression library, and is essential for the component libCGAL_ImageIO. -In \cgal this library is used in the examples of the \ref PkgSurfaceMesher3 package. +In \cgal this library is used in the examples of the \ref PkgSurfaceMesher3Ref package. If it is not already on your system, for instance, on Windows, you can download it from `http://www.zlib.net/`. @@ -511,7 +511,7 @@ represented using \sc{Mpfr} reliable floating-point numbers. It is based on the libraries \sc{Gmp} and \sc{Mpfr}. In the setting of \cgal, this library is optional: it is used by some models of the -\ref PkgAlgebraicKerneld "Algebraic Kernel". +\ref PkgAlgebraicKerneldRef "Algebraic Kernel". \sc{Mpfi} can be downloaded from `http://mpfi.gforge.inria.fr/`. Version 1.4 or higher is recommended. @@ -520,7 +520,7 @@ optional: it is used by some models of the \sc{Rs} (Real Solutions) is devoted to the study of the real roots of polynomial systems with a finite number of complex roots (including univariate polynomials). In \cgal, \sc{Rs} is used by one model of the -\ref PkgAlgebraicKerneld "Algebraic Kernel". +\ref PkgAlgebraicKerneldRef "Algebraic Kernel". \sc{Rs} is freely distributable for non-commercial use. You can download it from `http://vegas.loria.fr/rs/`. Actually, the \sc{Rs} package also includes \sc{Rs3}, the @@ -543,11 +543,11 @@ to speed up operations of the Polynomial package, such as GCDs. It is recommende \sc{Eigen} is a `C++` template library for linear algebra. \sc{Eigen} supports all matrix sizes, various matrix decomposition methods and sparse linear solvers. -In \cgal, \sc{Eigen} provides sparse linear solvers in the \ref PkgPoissonSurfaceReconstruction -and the \ref PkgSurfaceParameterization packages. +In \cgal, \sc{Eigen} provides sparse linear solvers in the \ref PkgPoissonSurfaceReconstructionRef +and the \ref PkgSurfaceParameterizationRef packages. -In addition, \sc{Eigen} also provides singular value decomposition for the \ref PkgJet_fitting_3 -and the \ref PkgRidges_3 packages. +In addition, \sc{Eigen} also provides singular value decomposition for the \ref PkgJet_fitting_3Ref +and the \ref PkgRidges_3Ref packages. The \sc{Eigen} web site is `http://eigen.tuxfamily.org`. @@ -557,7 +557,7 @@ The \sc{Esbtl} (Easy Structural Biology Template Library) is a library that allo the handling of \sc{Pdb} data. In \cgal the \sc{Esbtl} is used in an example of the -\ref PkgSkinSurface3 package. +\ref PkgSkinSurface3Ref package. It can be downloaded from `http://esbtl.sourceforge.net/`. @@ -576,7 +576,7 @@ The \sc{Tbb} web site is `http: the LAS format (or the compressed LAZ format). In \cgal, \sc{LASlib} is used to provide input and output functions in -the \ref PkgPointSetProcessing package. +the \ref PkgPointSetProcessingRef package. The \sc{LASlib} web site is `https://rapidlasso.com/lastools/`. \sc{LASlib} @@ -589,7 +589,7 @@ CMake based install procedure. \sc{OpenCV} (Open Computer Vision) is a library designed for computer vision, computer graphics and machine learning. -In \cgal, \sc{OpenCV} is used by the \ref PkgClassification package. +In \cgal, \sc{OpenCV} is used by the \ref PkgClassificationRef package. The \sc{OpenCV} web site is `http://opencv.org/`. diff --git a/Envelope_2/doc/Envelope_2/CGAL/Envelope_diagram_1.h b/Envelope_2/doc/Envelope_2/CGAL/Envelope_diagram_1.h index 5458eeee9f3..8bc3b12b7e4 100644 --- a/Envelope_2/doc/Envelope_2/CGAL/Envelope_diagram_1.h +++ b/Envelope_2/doc/Envelope_2/CGAL/Envelope_diagram_1.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgEnvelope2 +\ingroup PkgEnvelope2Ref This class is the default envelope-diagram class used by envelope functions to represent the minimization or the maximization diagram of a set of curves. diff --git a/Envelope_2/doc/Envelope_2/CGAL/envelope_2.h b/Envelope_2/doc/Envelope_2/CGAL/envelope_2.h index b6c9172ef2e..d45a0463b5f 100644 --- a/Envelope_2/doc/Envelope_2/CGAL/envelope_2.h +++ b/Envelope_2/doc/Envelope_2/CGAL/envelope_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgEnvelope2 +\ingroup PkgEnvelope2Ref Computes the lower envelope of a set of curves in \f$ \mathbb{R}^2\f$, as given by the range `[begin, end)`. The lower envelope is @@ -19,7 +19,7 @@ EnvelopeDiagram& diag); namespace CGAL { /*! -\ingroup PkgEnvelope2 +\ingroup PkgEnvelope2Ref Computes the lower envelope of a set of \f$ x\f$-monotone curves in \f$ \mathbb{R}^2\f$, as given by the range `[begin, end)`. The lower @@ -38,7 +38,7 @@ EnvelopeDiagram& diag); namespace CGAL { /*! -\ingroup PkgEnvelope2 +\ingroup PkgEnvelope2Ref Computes the upper envelope of a set of curves in \f$ \mathbb{R}^2\f$, as given by the range `[begin, end)`. The upper envelope is @@ -56,7 +56,7 @@ EnvelopeDiagram& diag); namespace CGAL { /*! -\ingroup PkgEnvelope2 +\ingroup PkgEnvelope2Ref Computes the upper envelope of a set of \f$ x\f$-monotone curves in \f$ \mathbb{R}^2\f$, as given by the range `[begin, end)`. The upper diff --git a/Envelope_2/doc/Envelope_2/PackageDescription.txt b/Envelope_2/doc/Envelope_2/PackageDescription.txt index 23f43104d00..d9129901f68 100644 --- a/Envelope_2/doc/Envelope_2/PackageDescription.txt +++ b/Envelope_2/doc/Envelope_2/PackageDescription.txt @@ -1,15 +1,15 @@ -/// \defgroup PkgEnvelope2 2D Envelopes Reference +/// \defgroup PkgEnvelope2Ref 2D Envelopes Reference /// \defgroup PkgEnvelope2Concepts Concepts -/// \ingroup PkgEnvelope2 +/// \ingroup PkgEnvelope2Ref /*! -\addtogroup PkgEnvelope2 +\addtogroup PkgEnvelope2Ref \todo check generated documentation \cgalPkgDescriptionBegin{2D Envelopes,PkgEnvelope2Summary} \cgalPkgPicture{Envelope_2/fig/Envelope_2.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Ron Wein} \cgalPkgDesc{This package consits of functions that computes the lower (or upper) envelope of a set of arbitrary curves in 2D. The output is represented as an envelope diagram, namely a subdivision of the \f$ x\f$-axis into intervals, such that the identity of the curves that induce the envelope on each interval is unique.} -\cgalPkgManuals{Chapter_Envelopes_of_Curves_in_2D,PkgEnvelope2} +\cgalPkgManuals{Chapter_Envelopes_of_Curves_in_2D,PkgEnvelope2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.3} diff --git a/Envelope_3/doc/Envelope_3/CGAL/Env_plane_traits_3.h b/Envelope_3/doc/Envelope_3/CGAL/Env_plane_traits_3.h index 47c5254d1db..c1a839a38be 100644 --- a/Envelope_3/doc/Envelope_3/CGAL/Env_plane_traits_3.h +++ b/Envelope_3/doc/Envelope_3/CGAL/Env_plane_traits_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgEnvelope3 +\ingroup PkgEnvelope3Ref The traits class `Env_plane_traits_3` models the `EnvelopeTraits_3` concept, and is used for the construction of lower and upper envelopes of planes diff --git a/Envelope_3/doc/Envelope_3/CGAL/Env_sphere_traits_3.h b/Envelope_3/doc/Envelope_3/CGAL/Env_sphere_traits_3.h index faffe652e84..157ad738d8f 100644 --- a/Envelope_3/doc/Envelope_3/CGAL/Env_sphere_traits_3.h +++ b/Envelope_3/doc/Envelope_3/CGAL/Env_sphere_traits_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgEnvelope3 +\ingroup PkgEnvelope3Ref The traits class `Env_sphere_traits_3` models the `EnvelopeTraits_3` concept, and is used for the construction of lower and upper envelopes diff --git a/Envelope_3/doc/Envelope_3/CGAL/Env_surface_data_traits_3.h b/Envelope_3/doc/Envelope_3/CGAL/Env_surface_data_traits_3.h index 30dbf206ca1..9c8fbdec403 100644 --- a/Envelope_3/doc/Envelope_3/CGAL/Env_surface_data_traits_3.h +++ b/Envelope_3/doc/Envelope_3/CGAL/Env_surface_data_traits_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgEnvelope3 +\ingroup PkgEnvelope3Ref The class `Env_surface_data_traits_3` is a model of the `EnvelopeTraits_3` concept and serves as a decorator class that allows the extension of the surfaces diff --git a/Envelope_3/doc/Envelope_3/CGAL/Env_triangle_traits_3.h b/Envelope_3/doc/Envelope_3/CGAL/Env_triangle_traits_3.h index 0043b162c32..87ade2cb2ff 100644 --- a/Envelope_3/doc/Envelope_3/CGAL/Env_triangle_traits_3.h +++ b/Envelope_3/doc/Envelope_3/CGAL/Env_triangle_traits_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgEnvelope3 +\ingroup PkgEnvelope3Ref The traits class `Env_triangle_traits_3` models the `EnvelopeTraits_3` concept, and is used for the construction of lower and upper envelopes diff --git a/Envelope_3/doc/Envelope_3/CGAL/envelope_3.h b/Envelope_3/doc/Envelope_3/CGAL/envelope_3.h index d5c6b319111..d281cdb698d 100644 --- a/Envelope_3/doc/Envelope_3/CGAL/envelope_3.h +++ b/Envelope_3/doc/Envelope_3/CGAL/envelope_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgEnvelope3 +\ingroup PkgEnvelope3Ref The class-template `Envelope_diagram_2` represents the minimization diagram that corresponds to the lower envelope of a set of curves, or the @@ -165,7 +165,7 @@ Envelope_diagram_2 (EnvTraits *traits); namespace CGAL { /*! -\ingroup PkgEnvelope3 +\ingroup PkgEnvelope3Ref Computes the lower envelope of a set of surfaces in \f$ \mathbb{R}^3\f$, as given by the range `[begin, end)`. The lower envelope is @@ -182,7 +182,7 @@ Envelope_diagram_2& diag); namespace CGAL { /*! -\ingroup PkgEnvelope3 +\ingroup PkgEnvelope3Ref Computes the lower envelope of a set of \f$ xy\f$-monotone surfaces in \f$ \mathbb{R}^3\f$, as given by the range `[begin, end)`. The lower @@ -199,7 +199,7 @@ Envelope_diagram_2& diag); namespace CGAL { /*! -\ingroup PkgEnvelope3 +\ingroup PkgEnvelope3Ref Computes the upper envelope of a set of surfaces in \f$ \mathbb{R}^3\f$, as given by the range `[begin, end)`. The upper envelope is @@ -216,7 +216,7 @@ Envelope_diagram_2& diag); namespace CGAL { /*! -\ingroup PkgEnvelope3 +\ingroup PkgEnvelope3Ref Computes the upper envelope of a set of \f$ xy\f$-monotone surfaces in \f$ \mathbb{R}^3\f$, as given by the range `[begin, end)`. The lower diff --git a/Envelope_3/doc/Envelope_3/PackageDescription.txt b/Envelope_3/doc/Envelope_3/PackageDescription.txt index afbadf2eaf2..104370cc5fa 100644 --- a/Envelope_3/doc/Envelope_3/PackageDescription.txt +++ b/Envelope_3/doc/Envelope_3/PackageDescription.txt @@ -1,15 +1,15 @@ -/// \defgroup PkgEnvelope3 3D Envelopes Reference +/// \defgroup PkgEnvelope3Ref 3D Envelopes Reference /// \defgroup PkgEnvelope3Concepts Concepts -/// \ingroup PkgEnvelope3 +/// \ingroup PkgEnvelope3Ref /*! -\addtogroup PkgEnvelope3 +\addtogroup PkgEnvelope3Ref \todo check generated documentation \cgalPkgDescriptionBegin{3D Envelopes,PkgEnvelope3Summary} \cgalPkgPicture{Envelope_3/fig/Envelope_3.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Dan Halperin, Michal Meyerovitch, Ron Wein, and Baruch Zukerman} \cgalPkgDesc{This package consits of functions that compute the lower (or upper) envelope of a set of arbitrary surfaces in 3D. The output is represented as an 2D envelope diagram, namely a planar subdivision such that the identity of the surfaces that induce the envelope over each diagram cell is unique.} -\cgalPkgManuals{Chapter_Envelopes_of_Surfaces_in_3D,PkgEnvelope3} +\cgalPkgManuals{Chapter_Envelopes_of_Surfaces_in_3D,PkgEnvelope3Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.3} diff --git a/Generalized_map/doc/Generalized_map/PackageDescription.txt b/Generalized_map/doc/Generalized_map/PackageDescription.txt index acbdf16ff7e..3193c61df9b 100644 --- a/Generalized_map/doc/Generalized_map/PackageDescription.txt +++ b/Generalized_map/doc/Generalized_map/PackageDescription.txt @@ -1,19 +1,19 @@ -/// \defgroup PkgGeneralizedMaps Generalized Maps Reference +/// \defgroup PkgGeneralizedMapsRef Generalized Maps Reference /// \defgroup PkgGeneralizedMapsConcepts Concepts -/// \ingroup PkgGeneralizedMaps +/// \ingroup PkgGeneralizedMapsRef /// \defgroup PkgGeneralizedMapsClasses Classes -/// \ingroup PkgGeneralizedMaps +/// \ingroup PkgGeneralizedMapsRef /*! -\addtogroup PkgGeneralizedMaps +\addtogroup PkgGeneralizedMapsRef \cgalPkgDescriptionBegin{Generalized Maps,PkgGeneralizedMapsSummary} \cgalPkgPicture{gmap_logo.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Guillaume Damiand} \cgalPkgDesc{This package implements Generalized Maps in d dimensions. A generalized map is a data structure enabling to represent an orientable or non orientable subdivided object by describing all the cells of the subdivision (for example in 3D vertices, edges, faces, volumes) and all the incidence and adjacency relationships between these cells. Information can be associated to cells thanks to attributes. The package provides basic creation, modification operations, and several iterators enabling to run through some specific part of the object.} -\cgalPkgManuals{Chapter_Generalized_Maps,PkgGeneralizedMaps} +\cgalPkgManuals{Chapter_Generalized_Maps,PkgGeneralizedMapsRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{4.9} diff --git a/Generator/doc/Generator/CGAL/Combination_enumerator.h b/Generator/doc/Generator/CGAL/Combination_enumerator.h index 80a57e20784..5e1873882c0 100644 --- a/Generator/doc/Generator/CGAL/Combination_enumerator.h +++ b/Generator/doc/Generator/CGAL/Combination_enumerator.h @@ -1,6 +1,6 @@ namespace CGAL { -/// \addtogroup PkgGenerators +/// \addtogroup PkgGeneratorsRef /// @{ /*! diff --git a/Generator/doc/Generator/CGAL/Random.h b/Generator/doc/Generator/CGAL/Random.h index ead823642c6..653aa3240ca 100644 --- a/Generator/doc/Generator/CGAL/Random.h +++ b/Generator/doc/Generator/CGAL/Random.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgGenerators +\ingroup PkgGeneratorsRef The class `Random` is a random numbers generator. It generates uniformly distributed random `bool`, `int` and `double`. It can be used as the random number generating function object in the @@ -180,7 +180,7 @@ bool operator == ( Random const& random2) const; }; /* end Random */ /*! - \ingroup PkgGenerators + \ingroup PkgGeneratorsRef The global function `get_default_random()` returns the default random numbers generator used for the generator functions and classes. The returned generator is thread local. @@ -188,7 +188,7 @@ bool operator == ( Random const& random2) const; Random &get_default_random(); /*! - \ingroup PkgGenerators + \ingroup PkgGeneratorsRef \deprecated The variable `default_random` was the default random numbers generator used for the generator functions and classes. Deprecated. Use `get_default_random()` instead. diff --git a/Generator/doc/Generator/CGAL/point_generators_2.h b/Generator/doc/Generator/CGAL/point_generators_2.h index 449f0444a20..4db77fafc06 100644 --- a/Generator/doc/Generator/CGAL/point_generators_2.h +++ b/Generator/doc/Generator/CGAL/point_generators_2.h @@ -1,6 +1,6 @@ namespace CGAL { -/// \addtogroup PkgGenerators +/// \addtogroup PkgGeneratorsRef /// @{ /*! diff --git a/Generator/doc/Generator/CGAL/point_generators_3.h b/Generator/doc/Generator/CGAL/point_generators_3.h index 631637941df..cb87e09ed95 100644 --- a/Generator/doc/Generator/CGAL/point_generators_3.h +++ b/Generator/doc/Generator/CGAL/point_generators_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgGenerators +\ingroup PkgGeneratorsRef \brief generates a given number of points on a cubic grid whose size is determined by the number of points to be generated. diff --git a/Generator/doc/Generator/CGAL/point_generators_d.h b/Generator/doc/Generator/CGAL/point_generators_d.h index aa103faaa8b..b064051adac 100644 --- a/Generator/doc/Generator/CGAL/point_generators_d.h +++ b/Generator/doc/Generator/CGAL/point_generators_d.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgGenerators +\ingroup PkgGeneratorsRef generates a given number of points on a cubic grid in any dimension whose size is determined by the number of points to be generated. diff --git a/Generator/doc/Generator/CGAL/random_convex_hull_in_disc_2.h b/Generator/doc/Generator/CGAL/random_convex_hull_in_disc_2.h index 3fd55c14b06..3800a0f7491 100644 --- a/Generator/doc/Generator/CGAL/random_convex_hull_in_disc_2.h +++ b/Generator/doc/Generator/CGAL/random_convex_hull_in_disc_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgGenerators +\ingroup PkgGeneratorsRef \brief Computes a random convex polygon as the convex hull of \f$ n \f$ random points in a disc centered at the origin with radius `radius`. diff --git a/Generator/doc/Generator/CGAL/random_convex_set_2.h b/Generator/doc/Generator/CGAL/random_convex_set_2.h index 750bc06592d..dea39b97031 100644 --- a/Generator/doc/Generator/CGAL/random_convex_set_2.h +++ b/Generator/doc/Generator/CGAL/random_convex_set_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgGenerators +\ingroup PkgGeneratorsRef \brief computes a random convex planar point set of given size where the points are drawn from a specific domain. diff --git a/Generator/doc/Generator/CGAL/random_polygon_2.h b/Generator/doc/Generator/CGAL/random_polygon_2.h index 1cb14cd4fdd..be9c8766f4b 100644 --- a/Generator/doc/Generator/CGAL/random_polygon_2.h +++ b/Generator/doc/Generator/CGAL/random_polygon_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgGenerators +\ingroup PkgGeneratorsRef \brief computes a random simple polygon by writing its vertices (oriented counterclockwise) to `result`. The polygon generated will have a number diff --git a/Generator/doc/Generator/CGAL/random_selection.h b/Generator/doc/Generator/CGAL/random_selection.h index 173008e7fa4..b1460b86816 100644 --- a/Generator/doc/Generator/CGAL/random_selection.h +++ b/Generator/doc/Generator/CGAL/random_selection.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgGenerators +\ingroup PkgGeneratorsRef \brief chooses `n` items at random from a random access iterator range which is useful to produce degenerate input data sets with multiple entries of identical items. diff --git a/Generator/doc/Generator/PackageDescription.txt b/Generator/doc/Generator/PackageDescription.txt index 2596c89d39d..22e04e8b38e 100644 --- a/Generator/doc/Generator/PackageDescription.txt +++ b/Generator/doc/Generator/PackageDescription.txt @@ -1,14 +1,14 @@ -/// \defgroup PkgGenerators Geometric Object Generators Reference +/// \defgroup PkgGeneratorsRef Geometric Object Generators Reference /// \defgroup PkgGeneratorsConcepts Concepts -/// \ingroup PkgGenerators +/// \ingroup PkgGeneratorsRef /*! -\addtogroup PkgGenerators +\addtogroup PkgGeneratorsRef \cgalPkgDescriptionBegin{Geometric Object Generators,PkgGeneratorsSummary} \cgalPkgPicture{dice.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Pedro M. M. de Castro, Olivier Devillers, Susan Hert, Michael Hoffmann, Lutz Kettner, Sven Schönherr, Alexandru Tifrea, and Maxime Gimeno} \cgalPkgDesc{This package provides a variety of generators for geometric objects. They are useful as synthetic test data sets, e.g. for testing algorithms on degenerate object sets and for performance analysis. } -\cgalPkgManuals{Chapter_Geometric_Object_Generators,PkgGenerators} +\cgalPkgManuals{Chapter_Geometric_Object_Generators,PkgGeneratorsRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{1.0} diff --git a/Geomview/doc/Geomview/CGAL/IO/Geomview_stream.h b/Geomview/doc/Geomview/CGAL/IO/Geomview_stream.h index 3b6cc552736..d189bb8367f 100644 --- a/Geomview/doc/Geomview/CGAL/IO/Geomview_stream.h +++ b/Geomview/doc/Geomview/CGAL/IO/Geomview_stream.h @@ -1,7 +1,7 @@ namespace CGAL { /*! - \ingroup PkgGeomview + \ingroup PkgGeomviewRef An object of the class `Geomview_stream` is a stream in which geometric objects can be inserted and where geometric objects can be extracted @@ -256,7 +256,7 @@ Geomview_stream& operator<<(Geomview_stream& gs, const Point_2& p); /// \addtogroup GeomviewOutput Output Operators for CGAL Kernel Classes -/// \ingroup PkgGeomview +/// \ingroup PkgGeomviewRef /// The following classes of the \cgal kernel have output /// operators. 2D objects are embedded in the `xy`-plane. /// @{ @@ -380,7 +380,7 @@ operator<<(Geomview_stream& gs, const Bbox_3& b); /// @} /// \addtogroup GeomviewInput Input Operators for CGAL Kernel Classes -/// \ingroup PkgGeomview +/// \ingroup PkgGeomviewRef /// An input operator is provided for points. The user has to select /// a point on the pick plane with the right mouse button. The pick plane /// can be moved anywhere with the left mouse button, before a point is entered. @@ -398,7 +398,7 @@ operator>>(Geomview_stream& gs, Point_3& p); /// @} /// \addtogroup GeomviewOutputClasses Output Operators for CGAL Basic Library Classes -/// \ingroup PkgGeomview +/// \ingroup PkgGeomviewRef /// Output operators are provided for polyhedral surfaces, as well as for 3D /// and 2D triangulations. The latter allow to visualize terrrains if the /// point type isa 3D point. diff --git a/Geomview/doc/Geomview/PackageDescription.txt b/Geomview/doc/Geomview/PackageDescription.txt index 7e598818921..fa1a6de594b 100644 --- a/Geomview/doc/Geomview/PackageDescription.txt +++ b/Geomview/doc/Geomview/PackageDescription.txt @@ -1,13 +1,13 @@ -/// \defgroup PkgGeomview Geomview Reference +/// \defgroup PkgGeomviewRef Geomview Reference /*! -\addtogroup PkgGeomview +\addtogroup PkgGeomviewRef \todo check generated documentation \cgalPkgDescriptionBegin{Geomview,PkgGeomviewSummary} \cgalPkgPicture{geomview.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Andreas Fabri and Sylvain Pion} \cgalPkgDesc{This package implements an interface to Geomview, an interactive 3D viewing program, originally developed at the Geometry Center in Minneapolis.} -\cgalPkgManuals{Chapter_Geomview,PkgGeomview} +\cgalPkgManuals{Chapter_Geomview,PkgGeomviewRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{2.0} diff --git a/GraphicsView/doc/GraphicsView/PackageDescription.txt b/GraphicsView/doc/GraphicsView/PackageDescription.txt index 01513917180..93e9c93f279 100644 --- a/GraphicsView/doc/GraphicsView/PackageDescription.txt +++ b/GraphicsView/doc/GraphicsView/PackageDescription.txt @@ -1,20 +1,20 @@ -/// \defgroup PkgGraphicsView CGAL and the Qt Graphics View Framework Reference +/// \defgroup PkgGraphicsViewRef CGAL and the Qt Graphics View Framework Reference /// \defgroup PkgGraphicsViewGraphicsItemClasses Graphics Item Classes -/// \ingroup PkgGraphicsView +/// \ingroup PkgGraphicsViewRef /// \defgroup PkgGraphicsViewInputClasses Input Classes -/// \ingroup PkgGraphicsView +/// \ingroup PkgGraphicsViewRef /// \defgroup PkgGraphicsViewMiscClasses Miscellaneous Classes -/// \ingroup PkgGraphicsView +/// \ingroup PkgGraphicsViewRef /*! -\addtogroup PkgGraphicsView +\addtogroup PkgGraphicsViewRef \cgalPkgDescriptionBegin{CGAL and the Qt Graphics View Framework,PkgGraphicsViewSummary} \cgalPkgPicture{detail.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Andreas Fabri and Laurent Rineau} \cgalPkgDesc{This package provides classes for displaying \cgal objects and data structures in the Qt 5 Graphics View Framework.} -\cgalPkgManuals{Chapter_CGAL_and_the_Qt_Graphics_View_Framework,PkgGraphicsView} +\cgalPkgManuals{Chapter_CGAL_and_the_Qt_Graphics_View_Framework,PkgGraphicsViewRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.4} diff --git a/HalfedgeDS/doc/HalfedgeDS/PackageDescription.txt b/HalfedgeDS/doc/HalfedgeDS/PackageDescription.txt index bca353bfb67..c0c6af84452 100644 --- a/HalfedgeDS/doc/HalfedgeDS/PackageDescription.txt +++ b/HalfedgeDS/doc/HalfedgeDS/PackageDescription.txt @@ -1,31 +1,31 @@ -/// \defgroup PkgHDS Halfedge Data Structures Reference +/// \defgroup PkgHDSRef Halfedge Data Structures Reference /// \defgroup PkgHDSConcepts Concepts -/// \ingroup PkgHDS +/// \ingroup PkgHDSRef /// \defgroup PkgHDS_HDS Halfedge Data Structures -/// \ingroup PkgHDS +/// \ingroup PkgHDSRef /// \defgroup PkgHDS_Items Item Classes -/// \ingroup PkgHDS +/// \ingroup PkgHDSRef /// \defgroup PkgHDS_VHF Vertices, Halfedges, Faces -/// \ingroup PkgHDS +/// \ingroup PkgHDSRef /// \defgroup PkgHDS_Decorators Decorators -/// \ingroup PkgHDS +/// \ingroup PkgHDSRef /// Classes that provide additional functions /// to examine and to modify a halfedge data structure. /*! -\addtogroup PkgHDS +\addtogroup PkgHDSRef \todo check generated documentation \cgalPkgDescriptionBegin{Halfedge Data Structures,PkgHDSSummary} \cgalPkgPicture{HalfedgeDS/fig/HalfedgeDS-teaser-small.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Lutz Kettner} \cgalPkgDesc{A halfedge data structure is an edge-centered data structure capable of maintaining incidence information of vertices, edges and faces, for example for planar maps, polyhedra, or other orientable, two-dimensional surfaces embedded in arbitrary dimension. Each edge is decomposed into two halfedges with opposite orientations. One incident face and one incident vertex are stored in each halfedge. For each face and each vertex, one incident halfedge is stored. Reduced variants of the halfedge data structure can omit some of these information, for example the halfedge pointers in faces or the storage of faces at all.} -\cgalPkgManuals{Chapter_Halfedge_Data_Structures,PkgHDS} +\cgalPkgManuals{Chapter_Halfedge_Data_Structures,PkgHDSRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{1.0} 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 4cbe9351891..106392639d5 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 @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgInscribedAreas +\ingroup PkgInscribedAreasRef \cgalAdvancedClass \cgalAdvancedBegin @@ -105,7 +105,7 @@ Orientation_2 orientation_2_object(); }; /* end Extremal_polygon_area_traits_2 */ /*! -\ingroup PkgInscribedAreas +\ingroup PkgInscribedAreasRef \cgalAdvancedClass \cgalAdvancedBegin diff --git a/Inscribed_areas/doc/Inscribed_areas/CGAL/Largest_empty_iso_rectangle_2.h b/Inscribed_areas/doc/Inscribed_areas/CGAL/Largest_empty_iso_rectangle_2.h index 716236ecf76..f464fb1fdee 100644 --- a/Inscribed_areas/doc/Inscribed_areas/CGAL/Largest_empty_iso_rectangle_2.h +++ b/Inscribed_areas/doc/Inscribed_areas/CGAL/Largest_empty_iso_rectangle_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgInscribedAreas +\ingroup PkgInscribedAreasRef Given a set of points in the plane, the class `Largest_empty_iso_rectangle_2` is a data structure that maintains an iso-rectangle with the largest area among diff --git a/Inscribed_areas/doc/Inscribed_areas/CGAL/extremal_polygon_2.h b/Inscribed_areas/doc/Inscribed_areas/CGAL/extremal_polygon_2.h index ebc2093435c..08c4b2a7031 100644 --- a/Inscribed_areas/doc/Inscribed_areas/CGAL/extremal_polygon_2.h +++ b/Inscribed_areas/doc/Inscribed_areas/CGAL/extremal_polygon_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgInscribedAreas +\ingroup PkgInscribedAreasRef computes a maximal (as specified by `t`) inscribed `k`-gon of the convex polygon described by [`points_begin`, @@ -49,7 +49,7 @@ const Traits& t); /*! -\ingroup PkgInscribedAreas +\ingroup PkgInscribedAreasRef \brief computes a maximum area inscribed `k`-gon of the convex polygon @@ -116,7 +116,7 @@ OutputIterator o); namespace CGAL { /*! -\ingroup PkgInscribedAreas +\ingroup PkgInscribedAreasRef \brief computes a maximum perimeter inscribed `k`-gon of the convex polygon described by `[points_begin, points_end)`, writes its diff --git a/Inscribed_areas/doc/Inscribed_areas/PackageDescription.txt b/Inscribed_areas/doc/Inscribed_areas/PackageDescription.txt index 929cb77847e..cf559fcc2ea 100644 --- a/Inscribed_areas/doc/Inscribed_areas/PackageDescription.txt +++ b/Inscribed_areas/doc/Inscribed_areas/PackageDescription.txt @@ -1,17 +1,17 @@ -/// \defgroup PkgInscribedAreas Inscribed Areas Reference +/// \defgroup PkgInscribedAreasRef Inscribed Areas Reference /// \defgroup PkgInscribedAreasConcepts Concepts -/// \ingroup PkgInscribedAreas +/// \ingroup PkgInscribedAreasRef /*! -\addtogroup PkgInscribedAreas +\addtogroup PkgInscribedAreasRef \todo check generated documentation \cgalPkgDescriptionBegin{Inscribed Areas,PkgInscribedAreasSummary} \cgalPkgPicture{ler-detail.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Michael Hoffmann and Eli Packer} \cgalPkgDesc{This package provides algorithms for computing inscribed areas. The algorithms for computing inscribed areas are: the largest inscribed k-gon (area or perimeter) of a convex point set and the largest inscribed iso-rectangle.} -\cgalPkgManuals{Chapter_Inscribed_Areas,PkgInscribedAreas} +\cgalPkgManuals{Chapter_Inscribed_Areas,PkgInscribedAreasRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{1.1} diff --git a/Interpolation/doc/Interpolation/CGAL/interpolation_functions.h b/Interpolation/doc/Interpolation/CGAL/interpolation_functions.h index bee04da3b82..778a2a63720 100644 --- a/Interpolation/doc/Interpolation/CGAL/interpolation_functions.h +++ b/Interpolation/doc/Interpolation/CGAL/interpolation_functions.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgInterpolation2 +\ingroup PkgInterpolation2Ref The struct `Data_access` implements a functor that allows to retrieve data from an associative container. The functor keeps a reference to diff --git a/Interpolation/doc/Interpolation/PackageDescription.txt b/Interpolation/doc/Interpolation/PackageDescription.txt index 1b13ef5d3b3..6a4b53f4442 100644 --- a/Interpolation/doc/Interpolation/PackageDescription.txt +++ b/Interpolation/doc/Interpolation/PackageDescription.txt @@ -1,19 +1,19 @@ -/// \defgroup PkgInterpolation2 2D and Surface Function Interpolation Reference +/// \defgroup PkgInterpolation2Ref 2D and Surface Function Interpolation Reference /// \defgroup PkgInterpolation2Concepts Concepts -/// \ingroup PkgInterpolation2 +/// \ingroup PkgInterpolation2Ref /// \defgroup PkgInterpolation2Interpolation Interpolation Functions -/// \ingroup PkgInterpolation2 +/// \ingroup PkgInterpolation2Ref /// \defgroup PkgInterpolation2NatNeighbor Natural Neighbor Coordinate Computation -/// \ingroup PkgInterpolation2 +/// \ingroup PkgInterpolation2Ref /// \defgroup PkgInterpolation2SurfaceNeighbor Surface Neighbor and Surface Neighbor Coordinate Computation -/// \ingroup PkgInterpolation2 +/// \ingroup PkgInterpolation2Ref /*! -\addtogroup PkgInterpolation2 +\addtogroup PkgInterpolation2Ref \cgalPkgDescriptionBegin{2D and Surface Function Interpolation,PkgInterpolation2Summary} \cgalPkgPicture{interpolation.png} \cgalPkgSummaryBegin @@ -21,7 +21,7 @@ \cgalPkgDesc{This package implements different methods for scattered data interpolation: Given measures of a function on a set of discrete data points, the task is to interpolate this function on an arbitrary query point. The package further offers functions for natural neighbor interpolation.} -\cgalPkgManuals{Chapter_2D_and_Surface_Function_Interpolation,PkgInterpolation2} +\cgalPkgManuals{Chapter_2D_and_Surface_Function_Interpolation,PkgInterpolation2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.1} diff --git a/Interval_skip_list/doc/Interval_skip_list/CGAL/Interval_skip_list.h b/Interval_skip_list/doc/Interval_skip_list/CGAL/Interval_skip_list.h index 0aa28b3c0d4..ad15203e6ce 100644 --- a/Interval_skip_list/doc/Interval_skip_list/CGAL/Interval_skip_list.h +++ b/Interval_skip_list/doc/Interval_skip_list/CGAL/Interval_skip_list.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgIntervalSkipList +\ingroup PkgIntervalSkipListRef The class `Interval_skip_list` is a dynamic data structure that allows to find all members of a set of intervals that overlap a point. diff --git a/Interval_skip_list/doc/Interval_skip_list/CGAL/Interval_skip_list_interval.h b/Interval_skip_list/doc/Interval_skip_list/CGAL/Interval_skip_list_interval.h index 6db50ce910f..d5a2ce3250f 100644 --- a/Interval_skip_list/doc/Interval_skip_list/CGAL/Interval_skip_list_interval.h +++ b/Interval_skip_list/doc/Interval_skip_list/CGAL/Interval_skip_list_interval.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgIntervalSkipList +\ingroup PkgIntervalSkipListRef The class `Interval_skip_list_interval` represents intervals with lower and upper bound of type `Value`. These intervals diff --git a/Interval_skip_list/doc/Interval_skip_list/CGAL/Level_interval.h b/Interval_skip_list/doc/Interval_skip_list/CGAL/Level_interval.h index 0175c59494e..eaa1db22fc9 100644 --- a/Interval_skip_list/doc/Interval_skip_list/CGAL/Level_interval.h +++ b/Interval_skip_list/doc/Interval_skip_list/CGAL/Level_interval.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgIntervalSkipList +\ingroup PkgIntervalSkipListRef The class `Level_interval` represents intervals for the minimum and maximum value of the `z`-coordinate of a face of a triangulation. diff --git a/Interval_skip_list/doc/Interval_skip_list/PackageDescription.txt b/Interval_skip_list/doc/Interval_skip_list/PackageDescription.txt index 30af0633afc..b9fc74b4a19 100644 --- a/Interval_skip_list/doc/Interval_skip_list/PackageDescription.txt +++ b/Interval_skip_list/doc/Interval_skip_list/PackageDescription.txt @@ -1,15 +1,15 @@ -/// \defgroup PkgIntervalSkipList Interval Skip List Reference +/// \defgroup PkgIntervalSkipListRef Interval Skip List Reference /// \defgroup PkgIntervalSkipListConcepts Concepts -/// \ingroup PkgIntervalSkipList +/// \ingroup PkgIntervalSkipListRef /*! -\addtogroup PkgIntervalSkipList +\addtogroup PkgIntervalSkipListRef \cgalPkgDescriptionBegin{Interval Skip List,PkgIntervalSkipListSummary} \cgalPkgPicture{Interval_skip_list/fig/query.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Andreas Fabri} \cgalPkgDesc{An interval skip list is a data structure for finding all intervals that contain a point, and for stabbing queries, that is for answering the question whether a given point is contained in an interval or not. For a triangulated terrain, this allows to quickly identify the triangles which intersect an iso line. } -\cgalPkgManuals{Chapter_Interval_Skip_List,PkgIntervalSkipList} +\cgalPkgManuals{Chapter_Interval_Skip_List,PkgIntervalSkipListRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.0} diff --git a/Jet_fitting_3/doc/Jet_fitting_3/CGAL/Monge_via_jet_fitting.h b/Jet_fitting_3/doc/Jet_fitting_3/CGAL/Monge_via_jet_fitting.h index 7f31a429a16..1d142275ebc 100644 --- a/Jet_fitting_3/doc/Jet_fitting_3/CGAL/Monge_via_jet_fitting.h +++ b/Jet_fitting_3/doc/Jet_fitting_3/CGAL/Monge_via_jet_fitting.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgJet_fitting_3 +\ingroup PkgJet_fitting_3Ref The class `Monge_via_jet_fitting` is designed to perform the estimation of the local differential quantities at a given point. The point range is @@ -39,7 +39,7 @@ public: /// @{ /*! -\ingroup PkgJet_fitting_3 +\ingroup PkgJet_fitting_3Ref The class `Monge_form` stores the Monge representation, i.e., the Monge coordinate system and the coefficients of the Monge form in this diff --git a/Jet_fitting_3/doc/Jet_fitting_3/PackageDescription.txt b/Jet_fitting_3/doc/Jet_fitting_3/PackageDescription.txt index ff80e0f65c4..ce78c9d23f5 100644 --- a/Jet_fitting_3/doc/Jet_fitting_3/PackageDescription.txt +++ b/Jet_fitting_3/doc/Jet_fitting_3/PackageDescription.txt @@ -1,15 +1,15 @@ -/// \defgroup PkgJet_fitting_3 Estimation of Local Differential Properties of Point-Sampled Surfaces Reference +/// \defgroup PkgJet_fitting_3Ref Estimation of Local Differential Properties of Point-Sampled Surfaces Reference /// \defgroup PkgJet_fitting_3Concepts Concepts -/// \ingroup PkgJet_fitting_3 +/// \ingroup PkgJet_fitting_3Ref /*! -\addtogroup PkgJet_fitting_3 +\addtogroup PkgJet_fitting_3Ref \todo check generated documentation \cgalPkgDescriptionBegin{Estimation of Local Differential Properties of Point-Sampled Surfaces,PkgJet_fitting_3Summary} \cgalPkgPicture{DavidDetail.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Marc Pouget and Frédéric Cazals} \cgalPkgDesc{For a surface discretized as a point cloud or a mesh, it is desirable to estimate pointwise differential quantities. More precisely, first order properties correspond to the normal or the tangent plane; second order properties provide the principal curvatures and directions, third order properties provide the directional derivatives of the principal curvatures along the curvature lines, etc. This package allows the estimation of local differential quantities of a surface from a point sample.} -\cgalPkgManuals{Chapter_Estimation_of_Local_Differential_Properties_of_Point-Sampled_Surfaces,PkgJet_fitting_3} +\cgalPkgManuals{Chapter_Estimation_of_Local_Differential_Properties_of_Point-Sampled_Surfaces,PkgJet_fitting_3Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.3} diff --git a/Kernel_23/doc/Kernel_23/CGAL/Origin.h b/Kernel_23/doc/Kernel_23/CGAL/Origin.h index ad1fccbaaa7..2b590a04bed 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Origin.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Origin.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgKernel23 +\ingroup PkgKernel23Ref \cgal defines a symbolic constant `NULL_VECTOR` to construct zero length vectors. @@ -21,7 +21,7 @@ public: namespace CGAL { /*! -\ingroup PkgKernel23 +\ingroup PkgKernel23Ref \cgal defines a symbolic constant `ORIGIN` which denotes the point at the origin. diff --git a/Kernel_23/doc/Kernel_23/PackageDescription.txt b/Kernel_23/doc/Kernel_23/PackageDescription.txt index aa5e95fc237..fc28676855d 100644 --- a/Kernel_23/doc/Kernel_23/PackageDescription.txt +++ b/Kernel_23/doc/Kernel_23/PackageDescription.txt @@ -1,7 +1,7 @@ -/// \defgroup PkgKernel23 2D and 3D Linear Geometry Kernel Reference +/// \defgroup PkgKernel23Ref 2D and 3D Linear Geometry Kernel Reference /// \defgroup PkgKernel23Concepts Concepts -/// \ingroup PkgKernel23 +/// \ingroup PkgKernel23Ref /// \defgroup PkgKernel23ConceptsGeomObject Kernel Geometric Object Concepts /// \ingroup PkgKernel23Concepts @@ -10,37 +10,37 @@ /// \ingroup PkgKernel23Concepts /// \defgroup kernel_predef Predefined Kernels -/// \ingroup PkgKernel23 +/// \ingroup PkgKernel23Ref /// \defgroup kernel_classes2 2D Kernel Objects -/// \ingroup PkgKernel23 +/// \ingroup PkgKernel23Ref /// \defgroup kernel_classes3 3D Kernel Objects -/// \ingroup PkgKernel23 +/// \ingroup PkgKernel23Ref /// \defgroup kernel_classes Kernel Classes -/// \ingroup PkgKernel23 +/// \ingroup PkgKernel23Ref /// \defgroup kernel_global_function Global Kernel Functions -/// \ingroup PkgKernel23 +/// \ingroup PkgKernel23Ref /// \defgroup kernel_enums Enumerations and Related Functions -/// \ingroup PkgKernel23 +/// \ingroup PkgKernel23Ref /// \defgroup kernel_conversion Cartesian/Homogenous Conversion -/// \ingroup PkgKernel23 +/// \ingroup PkgKernel23Ref /// \defgroup kernel_dimension Dimension Handling Tools -/// \ingroup PkgKernel23 +/// \ingroup PkgKernel23Ref /*! -\addtogroup PkgKernel23 +\addtogroup PkgKernel23Ref \cgalPkgDescriptionBegin{2D and 3D Linear Geometry Kernel,PkgKernel23Summary} \cgalPkgPicture{pointSegmentTriangle.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Hervé Brönnimann, Andreas Fabri, Geert-Jan Giezeman, Susan Hert, Michael Hoffmann, Lutz Kettner, Sylvain Pion, and Stefan Schirra} \cgalPkgDesc{This package contains kernels each containing objects of constant size, such as point, vector, direction, line, ray, segment, circle as well as predicates and constructions for these objects. The kernels mainly differ in the way they handle robustness issues.} -\cgalPkgManuals{Chapter_2D_and_3D_Geometry_Kernel,PkgKernel23} +\cgalPkgManuals{Chapter_2D_and_3D_Geometry_Kernel,PkgKernel23Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{0.9} diff --git a/Kernel_d/doc/Kernel_d/PackageDescription.txt b/Kernel_d/doc/Kernel_d/PackageDescription.txt index 296f53b8bf4..6a1d4bfb9dc 100644 --- a/Kernel_d/doc/Kernel_d/PackageDescription.txt +++ b/Kernel_d/doc/Kernel_d/PackageDescription.txt @@ -1,33 +1,33 @@ -/// \defgroup PkgKernelD dD Geometry Kernel Reference +/// \defgroup PkgKernelDRef dD Geometry Kernel Reference /// \defgroup PkgKernelDLinAlgConcepts Linear Algebra Concepts -/// \ingroup PkgKernelD +/// \ingroup PkgKernelDRef /// \defgroup PkgKernelDLinAlgClasses Linear Algebra Classes -/// \ingroup PkgKernelD +/// \ingroup PkgKernelDRef /// \defgroup PkgKernelDKernels Kernels -/// \ingroup PkgKernelD +/// \ingroup PkgKernelDRef /// \defgroup PkgKernelDKernelObjs Kernel Objects -/// \ingroup PkgKernelD +/// \ingroup PkgKernelDRef /// \defgroup PkgKernelDFunctions Global Kernel Functions -/// \ingroup PkgKernelD +/// \ingroup PkgKernelDRef /// \defgroup PkgKernelDKernelConcept Kernel Concept -/// \ingroup PkgKernelD +/// \ingroup PkgKernelDRef /*! -\addtogroup PkgKernelD +\addtogroup PkgKernelDRef \todo check generated documentation \cgalPkgDescriptionBegin{dD Geometry Kernel,PkgKernelDSummary} \cgalPkgPicture{hypercube.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Michael Seel} \cgalPkgDesc{The dD %Kernel contains objects of constant size, such as point, vector, direction, line, ray, segment, circle in d dimensional Euclidean space, as well as predicates and constructions for these objects.} -\cgalPkgManuals{Chapter_dD_Geometry_Kernel,PkgKernelD} +\cgalPkgManuals{Chapter_dD_Geometry_Kernel,PkgKernelDRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{1.1} diff --git a/Linear_cell_complex/doc/Linear_cell_complex/PackageDescription.txt b/Linear_cell_complex/doc/Linear_cell_complex/PackageDescription.txt index 8eb6f42e7dc..0cb3fa001a1 100644 --- a/Linear_cell_complex/doc/Linear_cell_complex/PackageDescription.txt +++ b/Linear_cell_complex/doc/Linear_cell_complex/PackageDescription.txt @@ -1,15 +1,15 @@ -/// \defgroup PkgLinearCellComplex Linear Cell Complex Reference +/// \defgroup PkgLinearCellComplexRef Linear Cell Complex Reference /// \defgroup PkgLinearCellComplexConcepts Concepts -/// \ingroup PkgLinearCellComplex +/// \ingroup PkgLinearCellComplexRef /// \defgroup PkgLinearCellComplexClasses Classes -/// \ingroup PkgLinearCellComplex +/// \ingroup PkgLinearCellComplexRef /*! Basic constructions. */ /// \defgroup PkgLinearCellComplexConstructions Constructions for Linear Cell Complex -/// \ingroup PkgLinearCellComplex +/// \ingroup PkgLinearCellComplexRef /*! High-level operations. \code @@ -17,7 +17,7 @@ \endcode */ /// \defgroup PkgLinearCellComplexOperations Operations for Linear Cell Complex -/// \ingroup PkgLinearCellComplex +/// \ingroup PkgLinearCellComplexRef /*! Draw. \code @@ -25,17 +25,17 @@ \endcode */ /// \defgroup PkgDrawLinearCellComplex Draw a Linear Cell Complex -/// \ingroup PkgLinearCellComplex +/// \ingroup PkgLinearCellComplexRef /*! -\addtogroup PkgLinearCellComplex +\addtogroup PkgLinearCellComplexRef \cgalPkgDescriptionBegin{Linear Cell Complex,PkgLinearCellComplexSummary} \cgalPkgPicture{lcc_logo.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Guillaume Damiand} \cgalPkgDesc{This package implements linear cell complexes, objects in d-dimension with linear geometry. The combinatorial part of objects is described either by a combinatorial or a generalized map, representing all the cells of the object plus the incidence and adjacency relations between cells. Geometry is added to the combinatorial data-structure simply by associating a point to each vertex of the map. Taking a 2D combinatorial map, and using 3D points, gives a linear cell complex equivalent to a Polyhedron_3.} -\cgalPkgManuals{Chapter_Linear_Cell_Complex,PkgLinearCellComplex} +\cgalPkgManuals{Chapter_Linear_Cell_Complex,PkgLinearCellComplexRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{4.0} diff --git a/Matrix_search/doc/Matrix_search/CGAL/Dynamic_matrix.h b/Matrix_search/doc/Matrix_search/CGAL/Dynamic_matrix.h index 4761f703302..96b960f8b4a 100644 --- a/Matrix_search/doc/Matrix_search/CGAL/Dynamic_matrix.h +++ b/Matrix_search/doc/Matrix_search/CGAL/Dynamic_matrix.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgMatrixSearch +\ingroup PkgMatrixSearchRef The class `Dynamic_matrix` is an adaptor for an arbitrary matrix class `M` to provide the dynamic operations needed for monotone diff --git a/Matrix_search/doc/Matrix_search/CGAL/Sorted_matrix_search_traits_adaptor.h b/Matrix_search/doc/Matrix_search/CGAL/Sorted_matrix_search_traits_adaptor.h index e4f01c40586..cff3fcffd6a 100644 --- a/Matrix_search/doc/Matrix_search/CGAL/Sorted_matrix_search_traits_adaptor.h +++ b/Matrix_search/doc/Matrix_search/CGAL/Sorted_matrix_search_traits_adaptor.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgMatrixSearch +\ingroup PkgMatrixSearchRef The class `Sorted_matrix_search_traits_adaptor` can be used as an adaptor to create sorted matrix search traits classes for diff --git a/Matrix_search/doc/Matrix_search/CGAL/monotone_matrix_search.h b/Matrix_search/doc/Matrix_search/CGAL/monotone_matrix_search.h index a62799d1a10..91b60ccd958 100644 --- a/Matrix_search/doc/Matrix_search/CGAL/monotone_matrix_search.h +++ b/Matrix_search/doc/Matrix_search/CGAL/monotone_matrix_search.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMatrixSearch +\ingroup PkgMatrixSearchRef \brief computes the maximum (as specified by `compare_strictly`) entry for each row of `m` and writes the corresponding column diff --git a/Matrix_search/doc/Matrix_search/CGAL/sorted_matrix_search.h b/Matrix_search/doc/Matrix_search/CGAL/sorted_matrix_search.h index f54578520b4..d27ad901387 100644 --- a/Matrix_search/doc/Matrix_search/CGAL/sorted_matrix_search.h +++ b/Matrix_search/doc/Matrix_search/CGAL/sorted_matrix_search.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMatrixSearch +\ingroup PkgMatrixSearchRef \brief returns the element `x` in one of the sorted matrices from the range `[f, l)`, for which `t.is_feasible(x)` diff --git a/Matrix_search/doc/Matrix_search/PackageDescription.txt b/Matrix_search/doc/Matrix_search/PackageDescription.txt index 97b2f8fbd5c..53af97c84b6 100644 --- a/Matrix_search/doc/Matrix_search/PackageDescription.txt +++ b/Matrix_search/doc/Matrix_search/PackageDescription.txt @@ -1,17 +1,17 @@ -/// \defgroup PkgMatrixSearch Monotone and Sorted Matrix Search Reference +/// \defgroup PkgMatrixSearchRef Monotone and Sorted Matrix Search Reference /// \defgroup PkgMatrixSearchConcepts Concepts -/// \ingroup PkgMatrixSearch +/// \ingroup PkgMatrixSearchRef /*! -\addtogroup PkgMatrixSearch +\addtogroup PkgMatrixSearchRef \todo check generated documentation \cgalPkgDescriptionBegin{Monotone and Sorted Matrix Search,PkgMatrixSearchSummary} \cgalPkgPicture{matrix.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Michael Hoffmann} \cgalPkgDesc{This package provides a matrix search framework, which is the underlying technique for the computation of all furthest neighbors for the vertices of a convex polygon, maximal k-gons inscribed into a planar point set, and computing rectangular p-centers.} -\cgalPkgManuals{Chapter_Monotone_and_Sorted_Matrix_Search,PkgMatrixSearch} +\cgalPkgManuals{Chapter_Monotone_and_Sorted_Matrix_Search,PkgMatrixSearchRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{1.1} diff --git a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_criteria_2.h b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_criteria_2.h index e80acb71a5b..3979f8baf04 100644 --- a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_criteria_2.h +++ b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_criteria_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgMesh2 +\ingroup PkgMesh2Ref diff --git a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_face_base_2.h b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_face_base_2.h index 3fe813eecfe..909c91012c5 100644 --- a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_face_base_2.h +++ b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_face_base_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgMesh2 +\ingroup PkgMesh2Ref diff --git a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_size_criteria_2.h b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_size_criteria_2.h index f8624d97adc..1c29f732f89 100644 --- a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_size_criteria_2.h +++ b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_size_criteria_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgMesh2 +\ingroup PkgMesh2Ref diff --git a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_vertex_base_2.h b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_vertex_base_2.h index 02894cb4e84..0eb0c2f8028 100644 --- a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_vertex_base_2.h +++ b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_vertex_base_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgMesh2 +\ingroup PkgMesh2Ref The class `Delaunay_mesh_vertex_base_2` is a model for the concept `DelaunayMeshVertexBase_2`. diff --git a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesher_2.h b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesher_2.h index 449cb10d6e7..dd71a465d4d 100644 --- a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesher_2.h +++ b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesher_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgMesh2 +\ingroup PkgMesh2Ref This class implements a 2D mesh generator. diff --git a/Mesh_2/doc/Mesh_2/CGAL/Mesh_2/Face_badness.h b/Mesh_2/doc/Mesh_2/CGAL/Mesh_2/Face_badness.h index fc3e577f324..57ac738075b 100644 --- a/Mesh_2/doc/Mesh_2/CGAL/Mesh_2/Face_badness.h +++ b/Mesh_2/doc/Mesh_2/CGAL/Mesh_2/Face_badness.h @@ -1,7 +1,7 @@ namespace CGAL { namespace Mesh_2 { /*! -\ingroup PkgMesh2 +\ingroup PkgMesh2Ref */ enum Face_badness { NOT_BAD, BAD, IMPERATIVELY_BAD}; diff --git a/Mesh_2/doc/Mesh_2/CGAL/Triangulation_conformer_2.h b/Mesh_2/doc/Mesh_2/CGAL/Triangulation_conformer_2.h index b0ff428a78e..2a8fcae9eef 100644 --- a/Mesh_2/doc/Mesh_2/CGAL/Triangulation_conformer_2.h +++ b/Mesh_2/doc/Mesh_2/CGAL/Triangulation_conformer_2.h @@ -40,7 +40,7 @@ template void make_conforming_Gabriel_2 (CDT &t); namespace CGAL { /*! -\ingroup PkgMesh2 +\ingroup PkgMesh2Ref The class `Triangulation_conformer_2` is an auxiliary class of diff --git a/Mesh_2/doc/Mesh_2/PackageDescription.txt b/Mesh_2/doc/Mesh_2/PackageDescription.txt index 79733d285b8..be61cc3a694 100644 --- a/Mesh_2/doc/Mesh_2/PackageDescription.txt +++ b/Mesh_2/doc/Mesh_2/PackageDescription.txt @@ -1,18 +1,18 @@ -/// \defgroup PkgMesh2 2D Conforming Triangulations and Meshes Reference +/// \defgroup PkgMesh2Ref 2D Conforming Triangulations and Meshes Reference /// \defgroup PkgMesh2Concepts Concepts -/// \ingroup PkgMesh2 +/// \ingroup PkgMesh2Ref /// \defgroup PkgMesh2Functions Mesh Generation Functions -/// \ingroup PkgMesh2 +/// \ingroup PkgMesh2Ref /// The main function to generate a mesh is `refine_Delaunay_mesh_2()`. /// The function `lloyd_optimize_mesh_2()` allows to optimize an existing mesh. /// \defgroup PkgMesh2Enum Enumerations -/// \ingroup PkgMesh2 +/// \ingroup PkgMesh2Ref /*! -\addtogroup PkgMesh2 +\addtogroup PkgMesh2Ref \cgalPkgDescriptionBegin{2D Conforming Triangulations and Meshes,PkgMesh2Summary} \cgalPkgPicture{Mesh_2/fig/delaunaymesh-small.png} \cgalPkgSummaryBegin @@ -23,7 +23,7 @@ Conforming Gabriel triangulations are obtained by further refining constrained The package provides also a 2D mesh generator that refines triangles and constrained edges until user defined size and shape criteria on triangles are satisfied. The generated meshes can be optimized using the Lloyd algorithm, also provided in this package. The package can handle intersecting input constraints and set no restriction on the angle formed by two constraints sharing an endpoint.} -\cgalPkgManuals{Chapter_2D_Conforming_Triangulations_and_Meshes,PkgMesh2} +\cgalPkgManuals{Chapter_2D_Conforming_Triangulations_and_Meshes,PkgMesh2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.1} diff --git a/Mesh_3/doc/Mesh_3/PackageDescription.txt b/Mesh_3/doc/Mesh_3/PackageDescription.txt index 791b9c7894b..f0d660ae7c5 100644 --- a/Mesh_3/doc/Mesh_3/PackageDescription.txt +++ b/Mesh_3/doc/Mesh_3/PackageDescription.txt @@ -1,45 +1,45 @@ -/// \defgroup PkgMesh_3 3D Mesh Generation Reference +/// \defgroup PkgMesh_3Ref 3D Mesh Generation Reference /// \defgroup PkgMesh_3Concepts Main Concepts -/// \ingroup PkgMesh_3 +/// \ingroup PkgMesh_3Ref /// The main concepts of this package. /// \defgroup PkgMesh_3SecondaryConcepts Secondary Concepts -/// \ingroup PkgMesh_3 +/// \ingroup PkgMesh_3Ref /// The concepts in this group are secondary concepts, related to the template parameters of some models of the main concept. /// \defgroup PkgMesh_3MeshClasses Mesh Classes -/// \ingroup PkgMesh_3 +/// \ingroup PkgMesh_3Ref /// The classes in this group are the main classes involved in the mesh generation process. /// \defgroup PkgMesh_3Domains Domain Classes -/// \ingroup PkgMesh_3 +/// \ingroup PkgMesh_3Ref /// The classes in this group are models of domain concepts and their associated classes. /// \defgroup PkgMesh_3Functions Mesh Generation Functions -/// \ingroup PkgMesh_3 +/// \ingroup PkgMesh_3Ref /// The two main functions to generate a mesh are `make_mesh_3()` and `refine_mesh_3()`. /// The other functions allow to optimize an existing mesh. /// \defgroup PkgMesh_3Parameters Parameter Functions -/// \ingroup PkgMesh_3 +/// \ingroup PkgMesh_3Ref /// \defgroup PkgMesh_3Enum Enumerations -/// \ingroup PkgMesh_3 +/// \ingroup PkgMesh_3Ref /// \defgroup PkgMesh_3IOFunctions Input/Output Functions -/// \ingroup PkgMesh_3 +/// \ingroup PkgMesh_3Ref /// The free functions that can be used to read and write meshes. /*! -\addtogroup PkgMesh_3 +\addtogroup PkgMesh_3Ref \todo check generated documentation \cgalPkgDescriptionBegin{3D Mesh Generation,PkgMesh_3Summary} \cgalPkgPicture{Mesh_3/fig/multilabel_mesher_small.jpg} \cgalPkgSummaryBegin \cgalPkgAuthors{Pierre Alliez, Clément Jamin, Laurent Rineau, Stéphane Tayeb, Jane Tournois, Mariette Yvinec} \cgalPkgDesc{This package is devoted to the generation of isotropic simplicial meshes discretizing 3D domains. The domain to be meshed is a region of 3D space that has to be bounded. The region may be connected or composed of multiple components and/or subdivided in several subdomains. The domain is input as an oracle able to answer queries, of a few different types, on the domain. Boundary and subdivision surfaces are either smooth or piecewise smooth surfaces, formed with planar or curved surface patches. Surfaces may exhibit 1-dimensional features (e.g. crease edges) and 0-dimensional features (e.g. singular points as corners tips, cusps or darts), that have to be fairly approximated in the mesh. Optionally, the algorithms support multi-core shared-memory architectures to take advantage of available parallelism.} -\cgalPkgManuals{Chapter_3D_Mesh_Generation,PkgMesh_3} +\cgalPkgManuals{Chapter_3D_Mesh_Generation,PkgMesh_3Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.5} 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 881bfb39dee..2100ae0d516 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 @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMinkowskiSum2 +\ingroup PkgMinkowskiSum2Ref The `Greene_convex_decomposition_2` class implements the approximation algorithm of Greene for the decomposition of an input polygon into convex @@ -68,7 +68,7 @@ public: namespace CGAL { /*! -\ingroup PkgMinkowskiSum2 +\ingroup PkgMinkowskiSum2Ref The `Optimal_convex_decomposition_2` class provides an implementation of Greene's dynamic programming algorithm for optimal decomposition of a diff --git a/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_nop_decomposition_2.h b/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_nop_decomposition_2.h index ece39aec050..b2843d722dc 100644 --- a/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_nop_decomposition_2.h +++ b/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_nop_decomposition_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMinkowskiSum2 +\ingroup PkgMinkowskiSum2Ref The `Polygon_nop_decomposition_2` class implements a convex decomposition of a polygon, which merely passes the input polygon to diff --git a/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_triangulation_decomposition_2.h b/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_triangulation_decomposition_2.h index b78e6adf9e9..4dd0cf19ca0 100644 --- a/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_triangulation_decomposition_2.h +++ b/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_triangulation_decomposition_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMinkowskiSum2 +\ingroup PkgMinkowskiSum2Ref The `Polygon_triangulation_decomposition_2` class implements a convex decomposition of a polygon or a polygon with holes into triangles using diff --git a/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_vertical_decomposition_2.h b/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_vertical_decomposition_2.h index d2a0a457a5a..28e560c6fd3 100644 --- a/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_vertical_decomposition_2.h +++ b/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_vertical_decomposition_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMinkowskiSum2 +\ingroup PkgMinkowskiSum2Ref The `Polygon_vertical_decomposition_2` class implements a convex decompistion of a polygon or a polygon with holes into pseudo trapezoids diff --git a/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Small_side_angle_bisector_decomposition_2.h b/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Small_side_angle_bisector_decomposition_2.h index ae6d95055d0..8688bbd2de9 100644 --- a/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Small_side_angle_bisector_decomposition_2.h +++ b/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Small_side_angle_bisector_decomposition_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMinkowskiSum2 +\ingroup PkgMinkowskiSum2Ref The `Small_side_angle_bisector_decomposition_2` class implements a simple yet efficient heuristic for decomposing an input polygon into convex sub-polygons. It is based diff --git a/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/approximated_offset_2.h b/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/approximated_offset_2.h index c6f376b9bae..4b98132bb68 100644 --- a/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/approximated_offset_2.h +++ b/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/approximated_offset_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMinkowskiSum2 +\ingroup PkgMinkowskiSum2Ref Provides a guaranteed approximation of the inset, or inner offset, of the given polygon `P` by a given radius `r`. Namely, the @@ -29,7 +29,7 @@ OutputIterator oi); namespace CGAL { /*! -\ingroup PkgMinkowskiSum2 +\ingroup PkgMinkowskiSum2Ref Provides a guaranteed approximation of the offset of the given polygon `P` by a given radius `r` - namely, the function computes the @@ -49,7 +49,7 @@ const typename Kernel::FT& r, const double& eps); /*! -\ingroup PkgMinkowskiSum2 +\ingroup PkgMinkowskiSum2Ref Provides a guaranteed approximation of offset the given polygon with holes `pwh` by a given radius `r`, such that the approximation error is bounded @@ -66,7 +66,7 @@ const typename Kernel::FT& r, const double& eps); /*! -\ingroup PkgMinkowskiSum2 +\ingroup PkgMinkowskiSum2Ref Provides a guaranteed approximation of the offset of the given polygon `P` by a radius `r`, as described above. diff --git a/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/minkowski_sum_2.h b/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/minkowski_sum_2.h index a0b5d14f579..5f23ea4e15c 100644 --- a/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/minkowski_sum_2.h +++ b/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/minkowski_sum_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMinkowskiSum2 +\ingroup PkgMinkowskiSum2Ref Computes the Minkowski sum \f$ P \oplus Q\f$ of two given polygons (which may have holes). `PolygonType1` and `PolygonType2` can be any combination of: @@ -20,7 +20,7 @@ minkowski_sum_2(const PolygonType1& P, const PolygonType2& Q); /*! -\ingroup PkgMinkowskiSum2 +\ingroup PkgMinkowskiSum2Ref Computes the Minkowski sum \f$ P \oplus Q\f$ of the two given polygons. The function computes the reduced convolution \cgalCite{cgal:bl-frmsurc-11} of @@ -42,7 +42,7 @@ minkowski_sum_by_reduced_convolution_2(const PolygonType1& P, const PolygonType2& Q); /*! -\ingroup PkgMinkowskiSum2 +\ingroup PkgMinkowskiSum2Ref Computes the Minkowski sum \f$ P \oplus Q\f$ of the two given polygons. The function computes the (full) convolution cycles of the two polygons and @@ -61,7 +61,7 @@ minkowski_sum_by_full_convolution_2(const Polygon_2& P, const Polygon_2& Q); /*! -\ingroup PkgMinkowskiSum2 +\ingroup PkgMinkowskiSum2Ref Computes the Minkowski sum \f$ P \oplus Q\f$ of the two given polygons. The function decomposes the summand `P` into convex sub-polygons @@ -92,7 +92,7 @@ minkowski_sum_2(const PolygonType1& P, const Gps_segment_traits_2& traits = Gps_segment_traits_2()); /*! -\ingroup PkgMinkowskiSum2 +\ingroup PkgMinkowskiSum2Ref Computes the Minkowski sum \f$ P \oplus Q\f$ of the two given polygons. The function decomposes the summands `P` and `Q` into convex sub-polygons @@ -114,7 +114,7 @@ minkowski_sum_2(const PolygonType1& P, const Gps_segment_traits_2& traits = Gps_segment_traits_2()); /*! -\ingroup PkgMinkowskiSum2 +\ingroup PkgMinkowskiSum2Ref Computes the Minkowski sum \f$ P \oplus Q\f$ of the two given polygons using the decomposition strategy. It decomposes the summands `P` and `Q` diff --git a/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/offset_polygon_2.h b/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/offset_polygon_2.h index e149088efd5..b07a2ae2a6d 100644 --- a/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/offset_polygon_2.h +++ b/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/offset_polygon_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMinkowskiSum2 +\ingroup PkgMinkowskiSum2Ref Computes the inset, or inner offset, of the given polygon `P` by a given radius `r` - namely, the function computes the set of points @@ -29,7 +29,7 @@ OutputIterator oi); namespace CGAL { /*! -\ingroup PkgMinkowskiSum2 +\ingroup PkgMinkowskiSum2Ref Computes the offset of the given polygon `P` by a given radius `r` - namely, the function computes the Minkowski sum @@ -51,7 +51,7 @@ const typename ConicTraits::Rat_kernel::FT& r, const ConicTraits& traits); /*! -\ingroup PkgMinkowskiSum2 +\ingroup PkgMinkowskiSum2Ref Computes the offset of the given polygon with holes `pwh` by a given radius `r`. It does so by offsetting outer boundary of `pwh` and @@ -70,7 +70,7 @@ const typename ConicTraits::Rat_kernel::FT& r, const ConicTraits& traits); /*! -\ingroup PkgMinkowskiSum2 +\ingroup PkgMinkowskiSum2Ref Computes the exact representation of the offset of the given polygon `P` by a radius `r`, as described above. diff --git a/Minkowski_sum_2/doc/Minkowski_sum_2/PackageDescription.txt b/Minkowski_sum_2/doc/Minkowski_sum_2/PackageDescription.txt index 19ea98938c3..da4cbc55053 100644 --- a/Minkowski_sum_2/doc/Minkowski_sum_2/PackageDescription.txt +++ b/Minkowski_sum_2/doc/Minkowski_sum_2/PackageDescription.txt @@ -1,16 +1,16 @@ -/// \defgroup PkgMinkowskiSum2 2D Minkowski Sums Reference +/// \defgroup PkgMinkowskiSum2Ref 2D Minkowski Sums Reference /// \defgroup PkgMinkowskiSum2Concepts Concepts -/// \ingroup PkgMinkowskiSum2 +/// \ingroup PkgMinkowskiSum2Ref /*! -\addtogroup PkgMinkowskiSum2 +\addtogroup PkgMinkowskiSum2Ref \cgalPkgDescriptionBegin{2D Minkowski Sums,PkgMinkowskiSum2Summary} \cgalPkgPicture{Minkowski_sum_2/fig/Minkowski_sum_2.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Ron Wein, Alon Baram, Eyal Flato, Efi Fogel, Michael Hemmer, Sebastian Morr} \cgalPkgDesc{This package consists of functions that compute the Minkowski sum of two simple straight-edge polygons in the plane. It also contains functions for computing the Minkowski sum of a polygon and a disc, an operation known as offsetting or dilating a polygon. The package can compute the exact representation of the offset polygon, or provide a guaranteed approximation of the offset.} -\cgalPkgManuals{Chapter_2D_Minkowski_Sums,PkgMinkowskiSum2} +\cgalPkgManuals{Chapter_2D_Minkowski_Sums,PkgMinkowskiSum2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.3} diff --git a/Minkowski_sum_2/include/CGAL/Minkowski_sum_2/AABB_tree_with_join.h b/Minkowski_sum_2/include/CGAL/Minkowski_sum_2/AABB_tree_with_join.h index 92ee60b1978..c742210a2e1 100644 --- a/Minkowski_sum_2/include/CGAL/Minkowski_sum_2/AABB_tree_with_join.h +++ b/Minkowski_sum_2/include/CGAL/Minkowski_sum_2/AABB_tree_with_join.h @@ -42,7 +42,7 @@ namespace CGAL { -/// \addtogroup PkgAABB_tree +/// \addtogroup PkgAABB_treeRef /// @{ /** diff --git a/Minkowski_sum_3/doc/Minkowski_sum_3/PackageDescription.txt b/Minkowski_sum_3/doc/Minkowski_sum_3/PackageDescription.txt index 6741691780a..96135dd13d6 100644 --- a/Minkowski_sum_3/doc/Minkowski_sum_3/PackageDescription.txt +++ b/Minkowski_sum_3/doc/Minkowski_sum_3/PackageDescription.txt @@ -1,14 +1,14 @@ -/// \defgroup PkgMinkowskiSum3 3D Minkowski Sum of Polyhedra Reference +/// \defgroup PkgMinkowskiSum3Ref 3D Minkowski Sum of Polyhedra Reference /*! -\addtogroup PkgMinkowskiSum3 +\addtogroup PkgMinkowskiSum3Ref \todo check generated documentation \cgalPkgDescriptionBegin{3D Minkowski Sum of Polyhedra,PkgMinkowskiSum3Summary} \cgalPkgPicture{Minkowski_sum_3/fig/Minkowski_sum_3_teaser.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Peter Hachenberger} \cgalPkgDesc{This package provides a function, which computes the Minkowski sum of two point sets in \f$ \mathbb{R}^3\f$. These point sets may consist of isolated vertices, isolated edges, surfaces with convex facets without holes, and open and closed solids. Thus, it is possible to compute the configuration space of translational robots (even in tight passage scenarios) as well as several graphics operations, like for instance the glide operation, which computes the point set swept by a polyhedron that moves along a polygonal line.} -\cgalPkgManuals{Chapter_3D_Minkowski_Sum_of_Polyhedra,PkgMinkowskiSum3} +\cgalPkgManuals{Chapter_3D_Minkowski_Sum_of_Polyhedra,PkgMinkowskiSum3Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.5} diff --git a/Minkowski_sum_3/include/CGAL/minkowski_sum_3.h b/Minkowski_sum_3/include/CGAL/minkowski_sum_3.h index 176645951bd..b7bb39e662d 100644 --- a/Minkowski_sum_3/include/CGAL/minkowski_sum_3.h +++ b/Minkowski_sum_3/include/CGAL/minkowski_sum_3.h @@ -33,7 +33,7 @@ namespace CGAL { /*! -\ingroup PkgMinkowskiSum3 +\ingroup PkgMinkowskiSum3Ref The function `minkowski_sum_3()` computes the Minkowski sum of two given 3D Nef polyhedra \f$ N0\f$ and \f$ N1\f$. Note that the function runs in diff --git a/Miscellany/doc/Miscellany/CGAL/Handle_hash_function.h b/Miscellany/doc/Miscellany/CGAL/Handle_hash_function.h index ebebe8f5659..9c971fdd098 100644 --- a/Miscellany/doc/Miscellany/CGAL/Handle_hash_function.h +++ b/Miscellany/doc/Miscellany/CGAL/Handle_hash_function.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgProfilingTools +\ingroup PkgProfilingToolsRef The class `Handle_hash_function` is a model for the `UniqueHashFunction` concept. It is applicable for all key types with pointer-like diff --git a/Miscellany/doc/Miscellany/CGAL/Memory_sizer.h b/Miscellany/doc/Miscellany/CGAL/Memory_sizer.h index 5c5df051208..d67bec9799c 100644 --- a/Miscellany/doc/Miscellany/CGAL/Memory_sizer.h +++ b/Miscellany/doc/Miscellany/CGAL/Memory_sizer.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgProfilingTools +\ingroup PkgProfilingToolsRef The class `Memory_sizer` allows to measure the memory size used by the process. Both the virtual memory size and the resident size are available (the resident diff --git a/Miscellany/doc/Miscellany/CGAL/Modifier_base.h b/Miscellany/doc/Miscellany/CGAL/Modifier_base.h index c53841d30a5..2ddf02559ef 100644 --- a/Miscellany/doc/Miscellany/CGAL/Modifier_base.h +++ b/Miscellany/doc/Miscellany/CGAL/Modifier_base.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgProfilingTools +\ingroup PkgProfilingToolsRef `Modifier_base` is an abstract base class providing the interface for any modifier. A modifier is a function object derived diff --git a/Miscellany/doc/Miscellany/CGAL/Profile_counter.h b/Miscellany/doc/Miscellany/CGAL/Profile_counter.h index 30b36d15693..d33866cfa68 100644 --- a/Miscellany/doc/Miscellany/CGAL/Profile_counter.h +++ b/Miscellany/doc/Miscellany/CGAL/Profile_counter.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgProfilingTools +\ingroup PkgProfilingToolsRef The class `Profile_counter` provides a way to count the number of times a given line of code is executed during the execution of a program, and print this diff --git a/Miscellany/doc/Miscellany/CGAL/Real_timer.h b/Miscellany/doc/Miscellany/CGAL/Real_timer.h index 775a1e013e4..d1d00e34160 100644 --- a/Miscellany/doc/Miscellany/CGAL/Real_timer.h +++ b/Miscellany/doc/Miscellany/CGAL/Real_timer.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgProfilingTools +\ingroup PkgProfilingToolsRef The class `Real_timer` is a timer class for measuring real time. A timer `t` of type `Real_timer` is an object with a state. It is diff --git a/Miscellany/doc/Miscellany/CGAL/Timer.h b/Miscellany/doc/Miscellany/CGAL/Timer.h index f0bac801705..172606c81cc 100644 --- a/Miscellany/doc/Miscellany/CGAL/Timer.h +++ b/Miscellany/doc/Miscellany/CGAL/Timer.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgProfilingTools +\ingroup PkgProfilingToolsRef The class `Timer` is a timer class for measuring user process time. diff --git a/Miscellany/doc/Miscellany/CGAL/Union_find.h b/Miscellany/doc/Miscellany/CGAL/Union_find.h index 86148c8c12c..4d9d3c9ca96 100644 --- a/Miscellany/doc/Miscellany/CGAL/Union_find.h +++ b/Miscellany/doc/Miscellany/CGAL/Union_find.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgProfilingTools +\ingroup PkgProfilingToolsRef An instance `P` of the data type `Union_find` is a partition of values of type `T` into disjoint sets. The template diff --git a/Miscellany/doc/Miscellany/CGAL/Unique_hash_map.h b/Miscellany/doc/Miscellany/CGAL/Unique_hash_map.h index 364240a2e93..d9c172360e6 100644 --- a/Miscellany/doc/Miscellany/CGAL/Unique_hash_map.h +++ b/Miscellany/doc/Miscellany/CGAL/Unique_hash_map.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgProfilingTools +\ingroup PkgProfilingToolsRef An instance of the class template `Unique_hash_map` is an injective mapping from the set of keys of type `Key` to the set of diff --git a/Miscellany/doc/Miscellany/PackageDescription.txt b/Miscellany/doc/Miscellany/PackageDescription.txt index 4e1880df2de..c9889a09e97 100644 --- a/Miscellany/doc/Miscellany/PackageDescription.txt +++ b/Miscellany/doc/Miscellany/PackageDescription.txt @@ -1,14 +1,14 @@ -/// \defgroup PkgProfilingTools Profiling Tools, Hash Map, Union-find, Modifiers Reference +/// \defgroup PkgProfilingToolsRef Profiling Tools, Hash Map, Union-find, Modifiers Reference /// \defgroup PkgProfilingToolsConcepts Concepts -/// \ingroup PkgProfilingTools +/// \ingroup PkgProfilingToolsRef /*! -\addtogroup PkgProfilingTools +\addtogroup PkgProfilingToolsRef \cgalPkgDescriptionBegin{Profiling tools\, Hash Map\, Union-find\, Modifiers,PkgProfilingToolsSummary} \cgalPkgPicture{stopwatch.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Lutz Kettner, Sylvain Pion, and Michael Seel} \cgalPkgDesc{This package provides classes for profiling time and memory consumption, profiling macros, a hash map, a union find data structure and a modifier.} -\cgalPkgManuals{Chapter_Profiling_Tools_Hash_Map_Union-find_Modifiers,PkgProfilingTools} +\cgalPkgManuals{Chapter_Profiling_Tools_Hash_Map_Union-find_Modifiers,PkgProfilingToolsRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.2} diff --git a/Modular_arithmetic/doc/Modular_arithmetic/CGAL/Modular_traits.h b/Modular_arithmetic/doc/Modular_arithmetic/CGAL/Modular_traits.h index b2c41119af1..4375c9ea9e1 100644 --- a/Modular_arithmetic/doc/Modular_arithmetic/CGAL/Modular_traits.h +++ b/Modular_arithmetic/doc/Modular_arithmetic/CGAL/Modular_traits.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgModularArithmetic +\ingroup PkgModularArithmeticRef An instance of `Modular_traits` is a model of `ModularTraits`, where T is the associated type. diff --git a/Modular_arithmetic/doc/Modular_arithmetic/CGAL/Residue.h b/Modular_arithmetic/doc/Modular_arithmetic/CGAL/Residue.h index 89e6b74b07e..bd494cfa0a6 100644 --- a/Modular_arithmetic/doc/Modular_arithmetic/CGAL/Residue.h +++ b/Modular_arithmetic/doc/Modular_arithmetic/CGAL/Residue.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgModularArithmetic +\ingroup PkgModularArithmeticRef \anchor Residue \brief The class `Residue` represents a finite field \f$ \mathbb{Z}{/p\mathbb{Z}}\f$, diff --git a/Modular_arithmetic/doc/Modular_arithmetic/PackageDescription.txt b/Modular_arithmetic/doc/Modular_arithmetic/PackageDescription.txt index 6e2cf7ab070..6e9f8f5d5fa 100644 --- a/Modular_arithmetic/doc/Modular_arithmetic/PackageDescription.txt +++ b/Modular_arithmetic/doc/Modular_arithmetic/PackageDescription.txt @@ -1,14 +1,14 @@ -/// \defgroup PkgModularArithmetic Modular Arithmetic Reference +/// \defgroup PkgModularArithmeticRef Modular Arithmetic Reference /// \defgroup PkgModularArithmeticConcepts Concepts -/// \ingroup PkgModularArithmetic +/// \ingroup PkgModularArithmeticRef /*! -\addtogroup PkgModularArithmetic +\addtogroup PkgModularArithmeticRef \cgalPkgDescriptionBegin{Modular Arithmetic,PkgModularArithmeticSummary} \cgalPkgPicture{Modular_arithmetic.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Michael Hemmer and Sylvain Pion} \cgalPkgDesc{This package provides arithmetic over finite fields. The provided tools are in particular useful for filters based on modular arithmetic and algorithms based on Chinese remainder. } -\cgalPkgManuals{Chapter_Modular_Arithmetic,PkgModularArithmetic} +\cgalPkgManuals{Chapter_Modular_Arithmetic,PkgModularArithmeticRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.4} diff --git a/Nef_2/doc/Nef_2/CGAL/Extended_cartesian.h b/Nef_2/doc/Nef_2/CGAL/Extended_cartesian.h index ecb679d14c4..95235341ae7 100644 --- a/Nef_2/doc/Nef_2/CGAL/Extended_cartesian.h +++ b/Nef_2/doc/Nef_2/CGAL/Extended_cartesian.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgNef2 +\ingroup PkgNef2Ref The class `Extended_cartesian` serves as a traits class for the class `Nef_polyhedron_2`. It uses a polynomial component diff --git a/Nef_2/doc/Nef_2/CGAL/Extended_homogeneous.h b/Nef_2/doc/Nef_2/CGAL/Extended_homogeneous.h index 1c77cd7f52e..d2091ba2fe9 100644 --- a/Nef_2/doc/Nef_2/CGAL/Extended_homogeneous.h +++ b/Nef_2/doc/Nef_2/CGAL/Extended_homogeneous.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgNef2 +\ingroup PkgNef2Ref The class `Extended_homogeneous` serves as a traits class for the class `Nef_polyhedron_2`. It uses a polynomial component diff --git a/Nef_2/doc/Nef_2/CGAL/Filtered_extended_homogeneous.h b/Nef_2/doc/Nef_2/CGAL/Filtered_extended_homogeneous.h index f70c8ad5d12..29eddd0b9b5 100644 --- a/Nef_2/doc/Nef_2/CGAL/Filtered_extended_homogeneous.h +++ b/Nef_2/doc/Nef_2/CGAL/Filtered_extended_homogeneous.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgNef2 +\ingroup PkgNef2Ref The class `Filtered_extended_homogeneous` serves as a traits class for the class `Nef_polyhedron_2`. It uses a polynomial component diff --git a/Nef_2/doc/Nef_2/CGAL/Nef_polyhedron_2.h b/Nef_2/doc/Nef_2/CGAL/Nef_polyhedron_2.h index a9b92f79b6d..afdc3c8dbd1 100644 --- a/Nef_2/doc/Nef_2/CGAL/Nef_polyhedron_2.h +++ b/Nef_2/doc/Nef_2/CGAL/Nef_polyhedron_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgNef2 +\ingroup PkgNef2Ref An instance of data type `Nef_polyhedron_2` is a subset of the plane that is the result of forming complements and intersections @@ -285,7 +285,7 @@ Nef_polyhedron_2 symmetric_difference(const Nef_polyhedron_2& N1) ; /// @{ /*! -\ingroup PkgNef2 +\ingroup PkgNef2Ref An instance `D` of the data type `Topological_explorer` is a decorator for interfacing the topological structure of a plane map @@ -661,7 +661,7 @@ void check_integrity_and_topological_planarity(bool faces=true) ; }; /* end Topological_explorer */ /*! -\ingroup PkgNef2 +\ingroup PkgNef2Ref a decorator to examine the underlying plane map. diff --git a/Nef_2/doc/Nef_2/PackageDescription.txt b/Nef_2/doc/Nef_2/PackageDescription.txt index 0ba157bc7bb..a312ba70d83 100644 --- a/Nef_2/doc/Nef_2/PackageDescription.txt +++ b/Nef_2/doc/Nef_2/PackageDescription.txt @@ -1,15 +1,15 @@ -/// \defgroup PkgNef2 2D Boolean Operations on Nef Polygons Reference +/// \defgroup PkgNef2Ref 2D Boolean Operations on Nef Polygons Reference /// \defgroup PkgNef2Concepts Concepts -/// \ingroup PkgNef2 +/// \ingroup PkgNef2Ref /*! -\addtogroup PkgNef2 +\addtogroup PkgNef2Ref \cgalPkgDescriptionBegin{2D Boolean Operations on Nef Polygons,PkgNef2Summary} \cgalPkgPicture{complex-teaser.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Michael Seel} \cgalPkgDesc{A Nef polygon is any set that can be obtained from a finite set of open halfspaces by set complement and set intersection operations. Due to the fact that all other binary set operations like union, difference and symmetric difference can be reduced to intersection and complement calculations, Nef polygons are also closed under those operations. Apart from the set complement operation there are more topological unary set operations that are closed in the domain of Nef polygons interior, boundary, and closure.} -\cgalPkgManuals{Chapter_2D_Boolean_Operations_on_Nef_Polygons,PkgNef2} +\cgalPkgManuals{Chapter_2D_Boolean_Operations_on_Nef_Polygons,PkgNef2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{2.3} diff --git a/Nef_3/doc/Nef_3/CGAL/Nef_nary_union_3.h b/Nef_3/doc/Nef_3/CGAL/Nef_nary_union_3.h index 12680890b93..c105a1a981b 100644 --- a/Nef_3/doc/Nef_3/CGAL/Nef_nary_union_3.h +++ b/Nef_3/doc/Nef_3/CGAL/Nef_nary_union_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgNef3 +\ingroup PkgNef3Ref This class helps to perform the union of a set of 3D Nef polyhedra efficiently. It succesively applies the binary union operation of diff --git a/Nef_3/doc/Nef_3/CGAL/Nef_polyhedron_3.h b/Nef_3/doc/Nef_3/CGAL/Nef_polyhedron_3.h index cccc47b1c72..0a148d74348 100644 --- a/Nef_3/doc/Nef_3/CGAL/Nef_polyhedron_3.h +++ b/Nef_3/doc/Nef_3/CGAL/Nef_polyhedron_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! - \ingroup PkgNef3 + \ingroup PkgNef3Ref A 3D Nef polyhedron is a subset of the 3-dimensional space that is the result of forming complements and intersections starting from a finite @@ -59,7 +59,7 @@ public: /// @{ /*! - \ingroup PkgNef3 + \ingroup PkgNef3Ref A Halfedge has a double meaning. In the global incidence structure of a `Nef_polyhedron_3` it is an oriented edge going from one vertex to another. @@ -185,7 +185,7 @@ public: }; /* end Halfedge */ /*! - \ingroup PkgNef3 + \ingroup PkgNef3Ref The type `Halffacet_cycle_iterator` iterates over a list of `Object_handles`. Each item of that list can either be assigned @@ -255,7 +255,7 @@ public: /*! - \ingroup PkgNef3 + \ingroup PkgNef3Ref A halffacet is an oriented, rectilinear bounded part of a plane. The following figure depicts the incidences to halfedges, vertices and the notion of facet @@ -361,7 +361,7 @@ public: }; /* end Halffacet */ /*! - \ingroup PkgNef3 + \ingroup PkgNef3Ref The type `SFace_cycle_iterator` iterates over a list of `Object_handles`. Each item of that list can either be assigned @@ -447,7 +447,7 @@ public: }; /* end SFace_cycle_iterator */ /*! - \ingroup PkgNef3 + \ingroup PkgNef3Ref An sface is described by its boundaries. Figures \ref figureNef3HalfedgeIncidences @@ -542,7 +542,7 @@ public: }; /* end SFace */ /*! - \ingroup PkgNef3 + \ingroup PkgNef3Ref A shalfedge is a great arc on a sphere map. Figure \ref figureNef3HalfedgeIncidences @@ -728,7 +728,7 @@ public: }; /* end SHalfedge */ /*! - \ingroup PkgNef3 + \ingroup PkgNef3Ref A shalfloop is a great circle on a sphere map. Figure \ref figureNef3HalfloopIncidences @@ -825,7 +825,7 @@ public: }; /* end SHalfloop */ /*! - \ingroup PkgNef3 + \ingroup PkgNef3Ref A vertex is a point in the 3-dimensional space. Its incidence structure can be accessed creating a sphere map of the vertex. @@ -877,7 +877,7 @@ public: }; /* end Vertex */ /*! - \ingroup PkgNef3 + \ingroup PkgNef3Ref A volume is a full-dimensional connected point set in \f$ \mathbb{R}^3\f$. It is bounded by several shells, i.e.\ a connected part of the boundary incident diff --git a/Nef_3/doc/Nef_3/PackageDescription.txt b/Nef_3/doc/Nef_3/PackageDescription.txt index 27cfa4f73cc..61462a586ca 100644 --- a/Nef_3/doc/Nef_3/PackageDescription.txt +++ b/Nef_3/doc/Nef_3/PackageDescription.txt @@ -1,18 +1,18 @@ -/// \defgroup PkgNef3 3D Boolean Operations on Nef Polyhedra Reference +/// \defgroup PkgNef3Ref 3D Boolean Operations on Nef Polyhedra Reference /// /// \defgroup PkgNef3IOFunctions I/O Functions -/// \ingroup PkgNef3 +/// \ingroup PkgNef3Ref /*! -\addtogroup PkgNef3 +\addtogroup PkgNef3Ref \todo check generated documentation \cgalPkgDescriptionBegin{3D Boolean Operations on Nef Polyhedra,PkgNef3Summary} \cgalPkgPicture{Nef_3-teaser.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Peter Hachenberger and Lutz Kettner} \cgalPkgDesc{3D Nef polyhedra, are a boundary representation for cell-complexes bounded by halfspaces that supports Boolean operations and topological operations in full generality including unbounded cells, mixed dimensional cells (e.g., isolated vertices and antennas). Nef polyhedra distinguish between open and closed sets and can represent non-manifold geometry.} -\cgalPkgManuals{Chapter_3D_Boolean_Operations_on_Nef_Polyhedra,PkgNef3} +\cgalPkgManuals{Chapter_3D_Boolean_Operations_on_Nef_Polyhedra,PkgNef3Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.1} diff --git a/Nef_S2/doc/Nef_S2/CGAL/Nef_polyhedron_S2.h b/Nef_S2/doc/Nef_S2/CGAL/Nef_polyhedron_S2.h index d1707cd9e5f..e8719594ff6 100644 --- a/Nef_S2/doc/Nef_S2/CGAL/Nef_polyhedron_S2.h +++ b/Nef_S2/doc/Nef_S2/CGAL/Nef_polyhedron_S2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgNefS2 +\ingroup PkgNefS2Ref An instance of data type `Nef_polyhedron_S2` is a subset of the sphere \f$ S_2\f$ that is the result of forming complements and @@ -74,7 +74,7 @@ public: /// @{ /*! -\ingroup PkgNefS2 +\ingroup PkgNefS2Ref An object `c` of type `Sphere_circle` is an oriented great circle on the surface of a unit sphere. Such circles correspond to @@ -172,7 +172,7 @@ Sphere_point orthogonal_pole() ; }; /* end Sphere_circle */ /*! -\ingroup PkgNefS2 +\ingroup PkgNefS2Ref An object `p` of type `Sphere_point` is a point on the surface of a unit sphere. Such points correspond to the nontrivial @@ -254,7 +254,7 @@ Sphere_point antipode() ; }; /* end Sphere_point */ /*! -\ingroup PkgNefS2 +\ingroup PkgNefS2Ref An object `s` of type `Sphere_segment` is a segment in the surface of a unit sphere that is part of a great circle trough the @@ -381,7 +381,7 @@ bool has_in_relative_interior(const Sphere_point& p) ; /*! -\ingroup PkgNefS2 +\ingroup PkgNefS2Ref The type `SFace_cycle_iterator` iterates over a list of `Object_handles`. Each item of that list can either be assigned @@ -467,7 +467,7 @@ operator SHalfloop_handle() const; }; /* end SFace_cycle_iterator */ /*! -\ingroup PkgNefS2 +\ingroup PkgNefS2Ref Figures \ref figureNefS2SVertexIncidences and \ref figureNefS2SHalfloopIncidences @@ -551,7 +551,7 @@ SFace_cycle_const_iterator sface_cycle_end() const; }; /* end SFace */ /*! -\ingroup PkgNefS2 +\ingroup PkgNefS2Ref A shalfedge is a great arc on a sphere map. The figure below @@ -696,7 +696,7 @@ bool in_inner_sface_cycle() const; }; /* end SHalfedge */ /*! -\ingroup PkgNefS2 +\ingroup PkgNefS2Ref A sloop is a great circle on a sphere. A shalfloop is an oriented sloop. It is always paired with a shalfloop whose supporting `Sphere_circle` is pointing in @@ -778,7 +778,7 @@ SFace_const_handle incident_sface() const; }; /* end SHalfloop */ /*! -\ingroup PkgNefS2 +\ingroup PkgNefS2Ref Figure \ref figureNefS2SVertexIncidences illustrates the incidence of a svertex on a sphere map. diff --git a/Nef_S2/doc/Nef_S2/PackageDescription.txt b/Nef_S2/doc/Nef_S2/PackageDescription.txt index c2619aec027..f9625e75312 100644 --- a/Nef_S2/doc/Nef_S2/PackageDescription.txt +++ b/Nef_S2/doc/Nef_S2/PackageDescription.txt @@ -1,13 +1,13 @@ -/// \defgroup PkgNefS2 2D Boolean Operations on Nef Polygons Embedded on the Sphere Reference +/// \defgroup PkgNefS2Ref 2D Boolean Operations on Nef Polygons Embedded on the Sphere Reference /*! -\addtogroup PkgNefS2 +\addtogroup PkgNefS2Ref \cgalPkgDescriptionBegin{2D Boolean Operations on Nef Polygons Embedded on the Sphere,PkgNefS2Summary} \cgalPkgPicture{Nef_S2-teaser-small.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Peter Hachenberger and Lutz Kettner} \cgalPkgDesc{This package offers the equivalent to 2D Nef Polygons in the plane. Here halfplanes correspond to half spheres delimited by great circles.} -\cgalPkgManuals{Chapter_2D_Boolean_Operations_on_Nef_Polygons_Embedded_on_the_Sphere,PkgNefS2} +\cgalPkgManuals{Chapter_2D_Boolean_Operations_on_Nef_Polygons_Embedded_on_the_Sphere,PkgNefS2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.1} diff --git a/Number_types/doc/Number_types/CGAL/number_type_config.h b/Number_types/doc/Number_types/CGAL/number_type_config.h index 3fa09cdb7a9..5d53ff8d521 100644 --- a/Number_types/doc/Number_types/CGAL/number_type_config.h +++ b/Number_types/doc/Number_types/CGAL/number_type_config.h @@ -1,3 +1,3 @@ -/// \ingroup PkgNumberTypes +/// \ingroup PkgNumberTypesRef /// an approximation of \f$ \pi \f$ #define CGAL_PI 3.14159265358979323846 diff --git a/Number_types/doc/Number_types/NumberTypeSupport.txt b/Number_types/doc/Number_types/NumberTypeSupport.txt index ddefc7048ef..7a5845f6f46 100644 --- a/Number_types/doc/Number_types/NumberTypeSupport.txt +++ b/Number_types/doc/Number_types/NumberTypeSupport.txt @@ -16,7 +16,7 @@ requirements, such that they can be successfully used in \cgal code. In general they are expected to be a model of an algebraic structure concepts and in case they model a subring of the real numbers they are also a model of `RealEmbeddable`. For an overview of the algebraic -structure concepts see Section \ref PkgAlgebraicFoundations. +structure concepts see Section \ref PkgAlgebraicFoundationsRef. \section Number_typesBuilt Built-in Number Types diff --git a/Number_types/doc/Number_types/PackageDescription.txt b/Number_types/doc/Number_types/PackageDescription.txt index 04b91bd7869..a63d56b7aef 100644 --- a/Number_types/doc/Number_types/PackageDescription.txt +++ b/Number_types/doc/Number_types/PackageDescription.txt @@ -1,45 +1,45 @@ -/// \defgroup PkgNumberTypes Number Types Reference +/// \defgroup PkgNumberTypesRef Number Types Reference /// \defgroup PkgNumberTypesConcepts Concepts -/// \ingroup PkgNumberTypes +/// \ingroup PkgNumberTypesRef /// \defgroup nt_builtin Built-in types -/// \ingroup PkgNumberTypes +/// \ingroup PkgNumberTypesRef /// \defgroup nt_core CORE -/// \ingroup PkgNumberTypes +/// \ingroup PkgNumberTypesRef /// \defgroup nt_leda LEDA -/// \ingroup PkgNumberTypes +/// \ingroup PkgNumberTypesRef /// \defgroup nt_gmp GMP -/// \ingroup PkgNumberTypes +/// \ingroup PkgNumberTypesRef /// \defgroup nt_cgal CGAL Number Types -/// \ingroup PkgNumberTypes +/// \ingroup PkgNumberTypesRef /// \defgroup nt_cgal CGAL Number Types -/// \ingroup PkgNumberTypes +/// \ingroup PkgNumberTypesRef /// \defgroup nt_rrational Relates Rational -/// \ingroup PkgNumberTypes +/// \ingroup PkgNumberTypesRef /// \defgroup nt_ralgebraic Relates Algebraic Extensions -/// \ingroup PkgNumberTypes +/// \ingroup PkgNumberTypesRef /// \defgroup nt_util Utilities -/// \ingroup PkgNumberTypes +/// \ingroup PkgNumberTypesRef /*! -\addtogroup PkgNumberTypes +\addtogroup PkgNumberTypesRef \todo check generated documentation \cgalPkgDescriptionBegin{Number Types,PkgNumberTypesSummary} \cgalPkgPicture{illustration.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Michael Hemmer, Susan Hert, Sylvain Pion, and Stefan Schirra} \cgalPkgDesc{This package provides number type concepts as well as number type classes and wrapper classes for third party number type libraries. } -\cgalPkgManuals{Chapter_Number_Types,PkgNumberTypes} +\cgalPkgManuals{Chapter_Number_Types,PkgNumberTypesRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{1.0} diff --git a/Optimal_transportation_reconstruction_2/doc/Optimal_transportation_reconstruction_2/PackageDescription.txt b/Optimal_transportation_reconstruction_2/doc/Optimal_transportation_reconstruction_2/PackageDescription.txt index 4bca3636d37..692a7cee60b 100644 --- a/Optimal_transportation_reconstruction_2/doc/Optimal_transportation_reconstruction_2/PackageDescription.txt +++ b/Optimal_transportation_reconstruction_2/doc/Optimal_transportation_reconstruction_2/PackageDescription.txt @@ -1,20 +1,20 @@ -/// \defgroup PkgOptimalTransportationReconstruction2 Optimal Transportation Curve Reconstruction Reference +/// \defgroup PkgOptimalTransportationReconstruction2Ref Optimal Transportation Curve Reconstruction Reference /// \defgroup PkgOptimalTransportationReconstruction2Concepts Concepts -/// \ingroup PkgOptimalTransportationReconstruction2 +/// \ingroup PkgOptimalTransportationReconstruction2Ref /// \defgroup PkgOptimalTransportationReconstruction2Classes Classes -/// \ingroup PkgOptimalTransportationReconstruction2 +/// \ingroup PkgOptimalTransportationReconstruction2Ref /*! -\addtogroup PkgOptimalTransportationReconstruction2 +\addtogroup PkgOptimalTransportationReconstruction2Ref \cgalPkgDescriptionBegin{Optimal Transportation Curve Reconstruction, PkgOptimalTransportationReconstruction2Summary} \cgalPkgPicture{RS_2_small.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Pierre Alliez, David Cohen-Steiner, Fernando de Goes, Clément Jamin, Ivo Vigan} \cgalPkgDesc{This package provides an algorithm to reconstruct and simplify a shape from a point set in the plane, possibly hampered with noise and outliers. It generates as output a set of line segments and isolated points, which approximate the input point set.} -\cgalPkgManuals{Chapter_Optimal_Transportation_Curve_Reconstruction, PkgOptimalTransportationReconstruction2} +\cgalPkgManuals{Chapter_Optimal_Transportation_Curve_Reconstruction, PkgOptimalTransportationReconstruction2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{4.8} diff --git a/Partition_2/doc/Partition_2/CGAL/Partition_is_valid_traits_2.h b/Partition_2/doc/Partition_2/CGAL/Partition_is_valid_traits_2.h index 0907ad2079c..aac6c1113d4 100644 --- a/Partition_2/doc/Partition_2/CGAL/Partition_is_valid_traits_2.h +++ b/Partition_2/doc/Partition_2/CGAL/Partition_is_valid_traits_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgPolygonPartitioning2 +\ingroup PkgPolygonPartitioning2Ref Class that derives a traits class for `partition_is_valid_2()` from a given traits class by defining the validity testing function object 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 9996785a690..b62785b087f 100644 --- a/Partition_2/doc/Partition_2/CGAL/Partition_traits_2.h +++ b/Partition_2/doc/Partition_2/CGAL/Partition_traits_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgPolygonPartitioning2 +\ingroup PkgPolygonPartitioning2Ref Traits class that can be used with all the 2-dimensional polygon partitioning algorithms. It is parameterized by 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 06cde3ab9f6..2ae6b776249 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 @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgPolygonPartitioning2 +\ingroup PkgPolygonPartitioning2Ref determines if the sequence of points in the range [`first`, `beyond`) defines a \f$ y\f$-monotone diff --git a/Partition_2/doc/Partition_2/CGAL/partition_2.h b/Partition_2/doc/Partition_2/CGAL/partition_2.h index d94eddd399a..d71a9cb2739 100644 --- a/Partition_2/doc/Partition_2/CGAL/partition_2.h +++ b/Partition_2/doc/Partition_2/CGAL/partition_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgPolygonPartitioning2 +\ingroup PkgPolygonPartitioning2Ref \brief computes a partition of the polygon defined by the points in the range [`first`, `beyond`) into convex polygons. The @@ -70,7 +70,7 @@ const Traits& traits = Default_traits); namespace CGAL { /*! -\ingroup PkgPolygonPartitioning2 +\ingroup PkgPolygonPartitioning2Ref \brief computes a partition of the polygon defined by the points in the range [`first`, `beyond`) into convex @@ -144,7 +144,7 @@ const Traits& traits = Default_traits); namespace CGAL { /*! -\ingroup PkgPolygonPartitioning2 +\ingroup PkgPolygonPartitioning2Ref \brief computes a partition of the polygon defined by the points in the range [`first`, `beyond`) into convex @@ -218,7 +218,7 @@ const Traits& traits = Default_traits); namespace CGAL { /*! -\ingroup PkgPolygonPartitioning2 +\ingroup PkgPolygonPartitioning2Ref \brief computes a partition of the polygon defined by the points in the range [`first`, `beyond`) into \f$ y\f$-monotone 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 afcca9a1f4b..db417a0b428 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 @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgPolygonPartitioning2 +\ingroup PkgPolygonPartitioning2Ref \brief determines if the polygons in the range [`poly_first`, `poly_beyond`) define a valid convex partition of the polygon defined by the points in the @@ -65,7 +65,7 @@ const Traits& traits = Default_traits); namespace CGAL { /*! -\ingroup PkgPolygonPartitioning2 +\ingroup PkgPolygonPartitioning2Ref \brief returns `true` iff the polygons in the range [`poly_first`, `poly_beyond`) define a valid partition of the polygon defined by the @@ -125,7 +125,7 @@ const Traits& traits = Default_traits); namespace CGAL { /*! -\ingroup PkgPolygonPartitioning2 +\ingroup PkgPolygonPartitioning2Ref \brief determines if the polygons in the range [`poly_first`, `poly_beyond`) define a valid \f$ y\f$-monotone partition of the simple, counterclockwise-oriented polygon represented by the points diff --git a/Partition_2/doc/Partition_2/PackageDescription.txt b/Partition_2/doc/Partition_2/PackageDescription.txt index aa18a804b3f..1a69f93f358 100644 --- a/Partition_2/doc/Partition_2/PackageDescription.txt +++ b/Partition_2/doc/Partition_2/PackageDescription.txt @@ -1,19 +1,19 @@ -/// \defgroup PkgPolygonPartitioning2 2D Polygon Partitioning Reference +/// \defgroup PkgPolygonPartitioning2Ref 2D Polygon Partitioning Reference /// \defgroup PkgPolygonPartitioning2Concepts Concepts -/// \ingroup PkgPolygonPartitioning2 +/// \ingroup PkgPolygonPartitioning2Ref /// \defgroup PkgPolygonPartitioning2FunctionObjectConcepts Function Object Concepts -/// \ingroup PkgPolygonPartitioning2 +/// \ingroup PkgPolygonPartitioning2Ref /// \defgroup PkgPolygonPartitioning2FunctionObjectClasses Function Object Classes -/// \ingroup PkgPolygonPartitioning2 +/// \ingroup PkgPolygonPartitioning2Ref /*! -\addtogroup PkgPolygonPartitioning2 +\addtogroup PkgPolygonPartitioning2Ref \todo check generated documentation \cgalPkgDescriptionBegin{2D Polygon Partitioning,PkgPolygonPartitioning2Summary} \cgalPkgPicture{Partition_2/fig/Partition_2-teaser-small.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Susan Hert} \cgalPkgDesc{This package provides functions for partitioning polygons in monotone or convex polygons. The algorithms can produce results with the minimal number of polygons, as well as approximations which have no more than four times the optimal number of convex pieces but they differ in their runtime complexities.} -\cgalPkgManuals{Chapter_2D_Polygon_Partitioning,PkgPolygonPartitioning2} +\cgalPkgManuals{Chapter_2D_Polygon_Partitioning,PkgPolygonPartitioning2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{2.3} diff --git a/Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/Concepts/Periodic_2TriangulationTraits_2.h b/Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/Concepts/Periodic_2TriangulationTraits_2.h index 20d5c2a68ec..781ffd7b85d 100644 --- a/Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/Concepts/Periodic_2TriangulationTraits_2.h +++ b/Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/Concepts/Periodic_2TriangulationTraits_2.h @@ -11,7 +11,7 @@ the geometric primitives used in the triangulation and some function object types for the required predicates on those primitives. It refines the concept -`TriangulationTraits_2` from the \cgal \ref PkgTriangulation2 package. It redefines the +`TriangulationTraits_2` from the \cgal \ref PkgTriangulation2Ref package. It redefines the geometric objects, predicates and constructions to work with point-offset pairs. In most cases the offsets will be (0,0) and the predicates from `TriangulationTraits_2` can be used diff --git a/Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/PackageDescription.txt b/Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/PackageDescription.txt index a1e8dcd7e66..d5ae6555a22 100644 --- a/Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/PackageDescription.txt +++ b/Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/PackageDescription.txt @@ -1,22 +1,22 @@ -/// \defgroup PkgPeriodic2Triangulation2 2D Periodic Triangulations Reference +/// \defgroup PkgPeriodic2Triangulation2Ref 2D Periodic Triangulations Reference /// \defgroup PkgPeriodic2Triangulation2Concepts Concepts -/// \ingroup PkgPeriodic2Triangulation2 +/// \ingroup PkgPeriodic2Triangulation2Ref /// \defgroup PkgPeriodic2Triangulation2MainClasses Main Classes -/// \ingroup PkgPeriodic2Triangulation2 +/// \ingroup PkgPeriodic2Triangulation2Ref /// \defgroup PkgPeriodic2Triangulation2TraitsClasses Traits Classes -/// \ingroup PkgPeriodic2Triangulation2 +/// \ingroup PkgPeriodic2Triangulation2Ref /// \defgroup PkgPeriodic2Triangulation2VertexFaceClasses Vertex and Face Classes -/// \ingroup PkgPeriodic2Triangulation2 +/// \ingroup PkgPeriodic2Triangulation2Ref /// \defgroup PkgPeriodic2Triangulation2Enums Enums -/// \ingroup PkgPeriodic2Triangulation2 +/// \ingroup PkgPeriodic2Triangulation2Ref /*! -\addtogroup PkgPeriodic2Triangulation2 +\addtogroup PkgPeriodic2Triangulation2Ref \cgalPkgDescriptionBegin{2D Periodic Triangulations,PkgPeriodic2Triangulation2Summary} \cgalPkgPicture{Periodic_2_triangulation_2/fig/p2Delaunay2_thumb.png} @@ -24,7 +24,7 @@ \cgalPkgSummaryBegin \cgalPkgAuthor{Nico Kruithof} \cgalPkgDesc{This package allows to build and handle triangulations of point sets in the two dimensional flat torus. Triangulations are built incrementally and can be modified by insertion or removal of vertices. They offer point location facilities. The package provides Delaunay triangulations and offers nearest neighbor queries and primitives to build the dual Voronoi diagrams.} -\cgalPkgManuals{Chapter_2D_Periodic_Triangulations,PkgPeriodic2Triangulation2} +\cgalPkgManuals{Chapter_2D_Periodic_Triangulations,PkgPeriodic2Triangulation2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin diff --git a/Periodic_3_mesh_3/doc/Periodic_3_mesh_3/PackageDescription.txt b/Periodic_3_mesh_3/doc/Periodic_3_mesh_3/PackageDescription.txt index bdeb479abca..3627cea8ab1 100644 --- a/Periodic_3_mesh_3/doc/Periodic_3_mesh_3/PackageDescription.txt +++ b/Periodic_3_mesh_3/doc/Periodic_3_mesh_3/PackageDescription.txt @@ -1,29 +1,29 @@ -/// \defgroup PkgPeriodic_3_mesh_3 3D Periodic Mesh Generation Reference +/// \defgroup PkgPeriodic_3_mesh_3Ref 3D Periodic Mesh Generation Reference /// \defgroup PkgPeriodic_3_mesh_3Concepts Concepts -/// \ingroup PkgPeriodic_3_mesh_3 +/// \ingroup PkgPeriodic_3_mesh_3Ref /// The concepts of this package. /// \defgroup PkgPeriodic_3_mesh_3MeshClasses Mesh Classes -/// \ingroup PkgPeriodic_3_mesh_3 +/// \ingroup PkgPeriodic_3_mesh_3Ref /// The classes in this group are the main classes involved in the mesh generation process. /// \defgroup PkgPeriodic_3_mesh_3Domains Domain Classes -/// \ingroup PkgPeriodic_3_mesh_3 +/// \ingroup PkgPeriodic_3_mesh_3Ref /// The classes in this group are models of domain concepts and their associated classes. /// \defgroup PkgPeriodic_3_mesh_3Functions Mesh Generation Functions -/// \ingroup PkgPeriodic_3_mesh_3 +/// \ingroup PkgPeriodic_3_mesh_3Ref /// The two main functions to generate a periodic mesh are `make_periodic_3_mesh_3()` /// and `refine_periodic_3_mesh_3()`. Other functions are provided to optimize /// an existing periodic mesh. /// \defgroup PkgPeriodic_3_mesh_3IOFunctions Input/Output Functions -/// \ingroup PkgPeriodic_3_mesh_3 +/// \ingroup PkgPeriodic_3_mesh_3Ref /// The free functions that can be used to read and write periodic meshes. /*! -\addtogroup PkgPeriodic_3_mesh_3 +\addtogroup PkgPeriodic_3_mesh_3Ref \cgalPkgDescriptionBegin{3D Periodic Mesh Generation,PkgPeriodic_3_mesh_3Summary} \cgalPkgPicture{periodic_mesher_small.png} \cgalPkgSummaryBegin @@ -32,7 +32,7 @@ discretizing periodic 3D domains. The domain to be meshed is a region of the three-dimensional flat torus. The periodic mesh generator provides users with the same flexibility that is offered in the \ref PkgMesh_3Summary package.} -\cgalPkgManuals{Chapter_3D_Periodic_Mesh_Generation,PkgPeriodic_3_mesh_3} +\cgalPkgManuals{Chapter_3D_Periodic_Mesh_Generation,PkgPeriodic_3_mesh_3Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{4.13} diff --git a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/PackageDescription.txt b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/PackageDescription.txt index 10ba236de93..cb7391d4fa5 100644 --- a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/PackageDescription.txt +++ b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/PackageDescription.txt @@ -1,16 +1,16 @@ -/// \defgroup PkgPeriodic3Triangulation3 3D Periodic Triangulations Reference +/// \defgroup PkgPeriodic3Triangulation3Ref 3D Periodic Triangulations Reference /// \defgroup PkgPeriodic3Triangulation3Concepts Concepts -/// \ingroup PkgPeriodic3Triangulation3 +/// \ingroup PkgPeriodic3Triangulation3Ref /// \defgroup PkgPeriodic3Triangulation3MainClasses Main Classes -/// \ingroup PkgPeriodic3Triangulation3 +/// \ingroup PkgPeriodic3Triangulation3Ref /// \defgroup PkgPeriodic3Triangulation3TraitsClasses Traits Classes -/// \ingroup PkgPeriodic3Triangulation3 +/// \ingroup PkgPeriodic3Triangulation3Ref /*! -\addtogroup PkgPeriodic3Triangulation3 +\addtogroup PkgPeriodic3Triangulation3Ref \cgalPkgDescriptionBegin{3D Periodic Triangulations,PkgPeriodic3Triangulation3Summary} \cgalPkgPicture{p3Delaunay3_small.jpg} @@ -21,7 +21,7 @@ in the three dimensional flat torus. Triangulations are built incrementally and can be modified by insertion or removal of vertices. They offer point location facilities. The package provides Delaunay and regular triangulations and offers nearest neighbor queries and primitives to build the dual Voronoi diagrams.} -\cgalPkgManuals{Chapter_3D_Periodic_Triangulations,PkgPeriodic3Triangulation3} +\cgalPkgManuals{Chapter_3D_Periodic_Triangulations,PkgPeriodic3Triangulation3Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.5} diff --git a/Point_set_2/doc/Point_set_2/CGAL/Point_set_2.h b/Point_set_2/doc/Point_set_2/CGAL/Point_set_2.h index 505d18591cd..6938484d48e 100644 --- a/Point_set_2/doc/Point_set_2/CGAL/Point_set_2.h +++ b/Point_set_2/doc/Point_set_2/CGAL/Point_set_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgPointSet2 +\ingroup PkgPointSet2Ref An instance `PS` of the data type `Point_set_2` is a Delaunay Triangulation of its vertex set. The class `Point_set_2` is inherited from the \cgal Delaunay triangulation, diff --git a/Point_set_2/doc/Point_set_2/PackageDescription.txt b/Point_set_2/doc/Point_set_2/PackageDescription.txt index c6a422cf1e9..c629950dc3e 100644 --- a/Point_set_2/doc/Point_set_2/PackageDescription.txt +++ b/Point_set_2/doc/Point_set_2/PackageDescription.txt @@ -1,22 +1,22 @@ -/// \defgroup PkgPointSet2 2D Range and Neighbor Search Reference +/// \defgroup PkgPointSet2Ref 2D Range and Neighbor Search Reference /// \defgroup PkgPointSet2Concepts Concepts -/// \ingroup PkgPointSet2 +/// \ingroup PkgPointSet2Ref /// \defgroup PkgPointSet2RangeSearch Range Search -/// \ingroup PkgPointSet2 +/// \ingroup PkgPointSet2Ref /// \defgroup PkgPointSet2NeighborSearch Nearest Neighbor Search -/// \ingroup PkgPointSet2 +/// \ingroup PkgPointSet2Ref /*! -\addtogroup PkgPointSet2 +\addtogroup PkgPointSet2Ref \todo check generated documentation \cgalPkgDescriptionBegin{2D Range and Neighbor Search,PkgPointSet2Summary} \cgalPkgPicture{Point_set_2/fig/point_set.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Matthias Bäsken} \cgalPkgDesc{This package supports circular, triangular, and isorectangular range search queries as well as (k) nearest neighbor search queries on 2D point sets. In contrast to the spatial searching package, this package uses a Delaunay triangulation as underlying data structure.} -\cgalPkgManuals{Chapter_2D_Range_and_Neighbor_Search,PkgPointSet2} +\cgalPkgManuals{Chapter_2D_Range_and_Neighbor_Search,PkgPointSet2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{2.1} diff --git a/Point_set_3/doc/Point_set_3/PackageDescription.txt b/Point_set_3/doc/Point_set_3/PackageDescription.txt index ba953ea5b1e..da7c382eeb9 100644 --- a/Point_set_3/doc/Point_set_3/PackageDescription.txt +++ b/Point_set_3/doc/Point_set_3/PackageDescription.txt @@ -1,12 +1,12 @@ /*! -\defgroup PkgPointSet3 3D Point Set Reference +\defgroup PkgPointSet3Ref 3D Point Set Reference \cgalPkgDescriptionBegin{3D Point Set, PkgPointSet3Summary} \cgalPkgPicture{point_set_3.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Simon Giraudot} \cgalPkgDesc{This component provides the user with a flexible 3D point set data structure. The user can define any additional property needed such as normal vectors, colors or labels. \cgal algorithms can be easily applied to this data structure.} -\cgalPkgManuals{Chapter_Point_Set_3, PkgPointSet3} +\cgalPkgManuals{Chapter_Point_Set_3, PkgPointSet3Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{4.10} @@ -22,7 +22,7 @@ - `CGAL::Point_set_3` \defgroup PkgPointSet3IO Input/Output -\ingroup PkgPointSet3 +\ingroup PkgPointSet3Ref \brief This module offers convenience overloads of input/ouput functions available in the \ref PkgPointSetProcessingSummary package. @@ -40,6 +40,6 @@ the `CGAL::Point_set_3` class with the name and type given by the PLY header or by the LAS standard. For a complete documentation of these functions, please refer to the -\ref PkgPointSetProcessing manual. +\ref PkgPointSetProcessingRef manual. */ diff --git a/Point_set_3/doc/Point_set_3/Point_set_3.txt b/Point_set_3/doc/Point_set_3/Point_set_3.txt index 60a5ba36a3b..466e79774e6 100644 --- a/Point_set_3/doc/Point_set_3/Point_set_3.txt +++ b/Point_set_3/doc/Point_set_3/Point_set_3.txt @@ -69,7 +69,7 @@ structure: the points and attributes are then accessed through ranges and property maps. The `CGAL::Point_set_3` class is a range that provides property maps: applying \cgal algorithms is straightforward. -As the \ref PkgPointSetProcessing "Point Set Processing" algorithms +As the \ref PkgPointSetProcessingRef "Point Set Processing" algorithms use \ref BGLNamedParameters to handle property maps, a method `CGAL::Point_set_3::parameters()` is provided: it returns a named parameter object with the right point and normal maps to read and diff --git a/Point_set_3/include/CGAL/Point_set_3.h b/Point_set_3/include/CGAL/Point_set_3.h index c5f3cba43e9..afb4f87349a 100644 --- a/Point_set_3/include/CGAL/Point_set_3.h +++ b/Point_set_3/include/CGAL/Point_set_3.h @@ -41,7 +41,7 @@ namespace CGAL { /*! - \ingroup PkgPointSet3 + \ingroup PkgPointSet3Ref \brief A collection of points with dynamically associated properties. @@ -67,7 +67,7 @@ namespace CGAL { removed elements. A garbage collection method must be called to really remove it from memory. - For convenience, all functions of the package \ref PkgPointSetProcessing + For convenience, all functions of the package \ref PkgPointSetProcessingRef are provided with an overload that takes a Point_set_3 object as an argument. diff --git a/Point_set_processing_3/doc/Point_set_processing_3/NamedParameters.txt b/Point_set_processing_3/doc/Point_set_processing_3/NamedParameters.txt index 154688a883d..a65bfbacfa0 100644 --- a/Point_set_processing_3/doc/Point_set_processing_3/NamedParameters.txt +++ b/Point_set_processing_3/doc/Point_set_processing_3/NamedParameters.txt @@ -1,6 +1,6 @@ /*! \defgroup psp_namedparameters Named Parameters for Point Set Processing -\ingroup PkgPointSetProcessing +\ingroup PkgPointSetProcessingRef In this package, all functions optional parameters are implemented as BGL optional named parameters (see \ref BGLNamedParameters for more information on how to use them). diff --git a/Point_set_processing_3/doc/Point_set_processing_3/PackageDescription.txt b/Point_set_processing_3/doc/Point_set_processing_3/PackageDescription.txt index b03c31e380f..cb6538835c0 100644 --- a/Point_set_processing_3/doc/Point_set_processing_3/PackageDescription.txt +++ b/Point_set_processing_3/doc/Point_set_processing_3/PackageDescription.txt @@ -1,38 +1,38 @@ /*! -\defgroup PkgPointSetProcessing Point Set Processing Reference +\defgroup PkgPointSetProcessingRef Point Set Processing Reference \defgroup PkgPointSetProcessingAlgorithms Algorithms -\ingroup PkgPointSetProcessing +\ingroup PkgPointSetProcessingRef Collection of algorithms of point set processing (smoothing, simplification, etc.). \defgroup PkgPointSetProcessingIO IO (XYZ/OFF Formats) -\ingroup PkgPointSetProcessing +\ingroup PkgPointSetProcessingRef Read and write points (with or without normal vectors) in XYZ and OFF formats. \defgroup PkgPointSetProcessingIOPly IO (PLY Format) -\ingroup PkgPointSetProcessing +\ingroup PkgPointSetProcessingRef Read and write points (with or without additional properties) in PLY format. \defgroup PkgPointSetProcessingIOLas IO (LAS Format) -\ingroup PkgPointSetProcessing +\ingroup PkgPointSetProcessingRef Read and write points (with or without additional properties) in LAS format. -\addtogroup PkgPointSetProcessing +\addtogroup PkgPointSetProcessingRef \cgalPkgDescriptionBegin{Point Set Processing,PkgPointSetProcessingSummary} \cgalPkgPicture{point_set_processing_detail.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Pierre Alliez, Simon Giraudot, Clément Jamin, Florent Lafarge, Quentin Mérigot, Jocelyn Meyron, Laurent Saboret, Nader Salman, Shihao Wu} \cgalPkgDesc{This \cgal component implements methods to analyze and process unorganized point sets. The input is an unorganized point set, possibly with normal attributes (unoriented or oriented). The point set can be analyzed to measure its average spacing, and processed through functions devoted to the simplification, outlier removal, smoothing, normal estimation, normal orientation and feature edges estimation.} -\cgalPkgManuals{Chapter_Point_Set_Processing,PkgPointSetProcessing} +\cgalPkgManuals{Chapter_Point_Set_Processing,PkgPointSetProcessingRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.5} diff --git a/Point_set_processing_3/doc/Point_set_processing_3/Point_set_processing_3.txt b/Point_set_processing_3/doc/Point_set_processing_3/Point_set_processing_3.txt index ccd0c750df0..4aece868ac7 100644 --- a/Point_set_processing_3/doc/Point_set_processing_3/Point_set_processing_3.txt +++ b/Point_set_processing_3/doc/Point_set_processing_3/Point_set_processing_3.txt @@ -143,7 +143,7 @@ CGAL::jet_estimate_normals normal_map (CGAL::Second_of_pair_property_map())); \endcode -Please refer to the [Reference Manual](@ref PkgPointSetProcessing) for +Please refer to the [Reference Manual](@ref PkgPointSetProcessingRef) for the detailed API of the Point Set Processing functions. @@ -636,7 +636,7 @@ point set: Several functions of this package provide a callback mechanism that enables the user to track the progress of the algorithms and to interrupt them if needed. A callback, in this package, is an instance of `CGAL::cpp11::function` that takes the advancement as a parameter (between 0. when the algorithm begins to 1. when the algorithm is completed) and that returns `true` if the algorithm should carry on, `false` otherwise. It is passed as a named parameter with an empty function as default. -Algorithms that support this mechanism are detailed in the [Reference Manual](@ref PkgPointSetProcessing), along with the effect that an early interruption has on the output. +Algorithms that support this mechanism are detailed in the [Reference Manual](@ref PkgPointSetProcessingRef), along with the effect that an early interruption has on the output. \subsection Point_set_processing_3Example_callbacks Example diff --git a/Point_set_shape_detection_3/doc/Point_set_shape_detection_3/PackageDescription.txt b/Point_set_shape_detection_3/doc/Point_set_shape_detection_3/PackageDescription.txt index 908d1c28ae3..f8755d8b6e3 100644 --- a/Point_set_shape_detection_3/doc/Point_set_shape_detection_3/PackageDescription.txt +++ b/Point_set_shape_detection_3/doc/Point_set_shape_detection_3/PackageDescription.txt @@ -1,15 +1,15 @@ /*! -\defgroup PkgPointSetShapeDetection3 Point Set Shape Detection Reference +\defgroup PkgPointSetShapeDetection3Ref Point Set Shape Detection Reference \defgroup PkgPointSetShapeDetection3Concepts Concepts -\ingroup PkgPointSetShapeDetection3 +\ingroup PkgPointSetShapeDetection3Ref \defgroup PkgPointSetShapeDetection3Shapes Shapes -\ingroup PkgPointSetShapeDetection3 +\ingroup PkgPointSetShapeDetection3Ref -\addtogroup PkgPointSetShapeDetection3 +\addtogroup PkgPointSetShapeDetection3Ref \cgalPkgDescriptionBegin{Point Set Shape Detection, PkgPointSetShapeDetection3Summary} \cgalPkgPicture{shapes_detail.png} @@ -17,7 +17,7 @@ \cgalPkgSummaryBegin \cgalPkgAuthors{Sven Oesau, Yannick Verdie, Clément Jamin, Pierre Alliez, Florent Lafarge, Simon Giraudot} \cgalPkgDesc{This component implements two primitive shape detection algorithms: efficient RANSAC and region growing. Planes are detected from point sets with unoriented normals. RANSAC also handles the following shapes: sphere, cylinder, cone and torus. Other types of shapes can be detected through implementing a class deriving from the base shape class.} -\cgalPkgManuals{Chapter_Point_Set_Shape_Detection, PkgPointSetShapeDetection3} +\cgalPkgManuals{Chapter_Point_Set_Shape_Detection, PkgPointSetShapeDetection3Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin diff --git a/Point_set_shape_detection_3/include/CGAL/Shape_detection_3.h b/Point_set_shape_detection_3/include/CGAL/Shape_detection_3.h index 4bf090f5e56..e8c8d8c28a9 100644 --- a/Point_set_shape_detection_3/include/CGAL/Shape_detection_3.h +++ b/Point_set_shape_detection_3/include/CGAL/Shape_detection_3.h @@ -21,7 +21,7 @@ // /** -* \ingroup PkgPointSetShapeDetection3 +* \ingroup PkgPointSetShapeDetection3Ref * \file CGAL/Shape_detection_3.h * Convenience header file including the headers of this package. */ diff --git a/Point_set_shape_detection_3/include/CGAL/Shape_detection_3/Efficient_RANSAC.h b/Point_set_shape_detection_3/include/CGAL/Shape_detection_3/Efficient_RANSAC.h index 5694bf54031..7c52d6ef45e 100644 --- a/Point_set_shape_detection_3/include/CGAL/Shape_detection_3/Efficient_RANSAC.h +++ b/Point_set_shape_detection_3/include/CGAL/Shape_detection_3/Efficient_RANSAC.h @@ -59,7 +59,7 @@ namespace CGAL { namespace Shape_detection_3 { /*! -\ingroup PkgPointSetShapeDetection3 +\ingroup PkgPointSetShapeDetection3Ref \brief A shape detection algorithm using a RANSAC method. Given a point set in 3D space with unoriented normals, sampled on surfaces, diff --git a/Point_set_shape_detection_3/include/CGAL/Shape_detection_3/Efficient_RANSAC_traits.h b/Point_set_shape_detection_3/include/CGAL/Shape_detection_3/Efficient_RANSAC_traits.h index dc2e8bddaea..8af00b65b00 100644 --- a/Point_set_shape_detection_3/include/CGAL/Shape_detection_3/Efficient_RANSAC_traits.h +++ b/Point_set_shape_detection_3/include/CGAL/Shape_detection_3/Efficient_RANSAC_traits.h @@ -39,7 +39,7 @@ namespace CGAL { namespace Shape_detection_3 { /*! - \ingroup PkgPointSetShapeDetection3 + \ingroup PkgPointSetShapeDetection3Ref \brief %Default traits class to use the shape detection class `Efficient_RANSAC`. \cgalModels `Shape_detection_3::Traits` diff --git a/Point_set_shape_detection_3/include/CGAL/Shape_detection_3/Region_growing.h b/Point_set_shape_detection_3/include/CGAL/Shape_detection_3/Region_growing.h index 2e0566b6bd1..9aa50891591 100644 --- a/Point_set_shape_detection_3/include/CGAL/Shape_detection_3/Region_growing.h +++ b/Point_set_shape_detection_3/include/CGAL/Shape_detection_3/Region_growing.h @@ -44,7 +44,7 @@ namespace Shape_detection_3 { /*! -\ingroup PkgPointSetShapeDetection3 +\ingroup PkgPointSetShapeDetection3Ref \brief A shape detection algorithm using a region growing method. Given a point set in 3D space with unoriented normals, sampled on surfaces, diff --git a/Point_set_shape_detection_3/include/CGAL/Shape_detection_3/Shape_detection_traits.h b/Point_set_shape_detection_3/include/CGAL/Shape_detection_3/Shape_detection_traits.h index e8f0852d845..3faacfc4e01 100644 --- a/Point_set_shape_detection_3/include/CGAL/Shape_detection_3/Shape_detection_traits.h +++ b/Point_set_shape_detection_3/include/CGAL/Shape_detection_3/Shape_detection_traits.h @@ -31,7 +31,7 @@ namespace CGAL { namespace Shape_detection_3 { /*! - \ingroup PkgPointSetShapeDetection3 + \ingroup PkgPointSetShapeDetection3Ref \brief %Default traits class to use the shape detection class `Efficient_RANSAC`. \cgalModels `Shape_detection_3::Traits` diff --git a/Point_set_shape_detection_3/include/CGAL/Shape_detection_3/property_maps.h b/Point_set_shape_detection_3/include/CGAL/Shape_detection_3/property_maps.h index f26597397a7..bf0e0e2c9f0 100644 --- a/Point_set_shape_detection_3/include/CGAL/Shape_detection_3/property_maps.h +++ b/Point_set_shape_detection_3/include/CGAL/Shape_detection_3/property_maps.h @@ -32,7 +32,7 @@ namespace CGAL { namespace Shape_detection_3 { /*! - \ingroup PkgPointSetShapeDetection3 + \ingroup PkgPointSetShapeDetection3Ref Property map that associate a point index to its assigned shape found by a shape detection algorithm (such as @@ -87,7 +87,7 @@ namespace Shape_detection_3 { }; /*! - \ingroup PkgPointSetShapeDetection3 + \ingroup PkgPointSetShapeDetection3Ref Property map that associates a detected plane object (`CGAL::Shape_detection_3::Plane`) to a `CGAL::Plane_3` object. diff --git a/Point_set_shape_detection_3/include/CGAL/regularize_planes.h b/Point_set_shape_detection_3/include/CGAL/regularize_planes.h index 14cb4907b22..148c9482c9d 100644 --- a/Point_set_shape_detection_3/include/CGAL/regularize_planes.h +++ b/Point_set_shape_detection_3/include/CGAL/regularize_planes.h @@ -21,7 +21,7 @@ // /** - * \ingroup PkgPointSetShapeDetection3 + * \ingroup PkgPointSetShapeDetection3Ref * \file CGAL/regularize_planes.h * */ @@ -540,7 +540,7 @@ void subgraph_mutually_orthogonal_clusters (std::vector >& // Public section // ---------------------------------------------------------------------------- -/// \ingroup PkgPointSetShapeDetection3 +/// \ingroup PkgPointSetShapeDetection3Ref /*! diff --git a/Poisson_surface_reconstruction_3/doc/Poisson_surface_reconstruction_3/PackageDescription.txt b/Poisson_surface_reconstruction_3/doc/Poisson_surface_reconstruction_3/PackageDescription.txt index 380bf560294..0639d3daa55 100644 --- a/Poisson_surface_reconstruction_3/doc/Poisson_surface_reconstruction_3/PackageDescription.txt +++ b/Poisson_surface_reconstruction_3/doc/Poisson_surface_reconstruction_3/PackageDescription.txt @@ -1,12 +1,12 @@ -/// \defgroup PkgPoissonSurfaceReconstruction Poisson Surface Reconstruction Reference +/// \defgroup PkgPoissonSurfaceReconstructionRef Poisson Surface Reconstruction Reference /*! -\addtogroup PkgPoissonSurfaceReconstruction +\addtogroup PkgPoissonSurfaceReconstructionRef \cgalPkgDescriptionBegin{Poisson Surface Reconstruction,PkgPoissonSurfaceReconstructionSummary} \cgalPkgPicture{surface_reconstruction_points_detail.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Pierre Alliez, Laurent Saboret, Gaël Guennebaud} \cgalPkgDesc{This package implements a surface reconstruction method: Poisson Surface Reconstruction. It takes as input a set of points with oriented normals and computes an implicit function. The \cgal surface mesh generator can then be used to extract an iso-surface from this function. } -\cgalPkgManuals{Chapter_Poisson_Surface_Reconstruction,PkgPoissonSurfaceReconstruction} +\cgalPkgManuals{Chapter_Poisson_Surface_Reconstruction,PkgPoissonSurfaceReconstructionRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.5} diff --git a/Poisson_surface_reconstruction_3/include/CGAL/Poisson_reconstruction_function.h b/Poisson_surface_reconstruction_3/include/CGAL/Poisson_reconstruction_function.h index c4d72553b36..d8555c71e8e 100644 --- a/Poisson_surface_reconstruction_3/include/CGAL/Poisson_reconstruction_function.h +++ b/Poisson_surface_reconstruction_3/include/CGAL/Poisson_reconstruction_function.h @@ -149,7 +149,7 @@ struct Special_wrapper_of_two_functions_keep_pointers { /*! -\ingroup PkgPoissonSurfaceReconstruction +\ingroup PkgPoissonSurfaceReconstructionRef \brief Implementation of the Poisson Surface Reconstruction method. diff --git a/Poisson_surface_reconstruction_3/include/CGAL/poisson_surface_reconstruction.h b/Poisson_surface_reconstruction_3/include/CGAL/poisson_surface_reconstruction.h index 3fa7f6b5fb9..cf9f00b73e2 100644 --- a/Poisson_surface_reconstruction_3/include/CGAL/poisson_surface_reconstruction.h +++ b/Poisson_surface_reconstruction_3/include/CGAL/poisson_surface_reconstruction.h @@ -34,7 +34,7 @@ namespace CGAL { /*! - \ingroup PkgPoissonSurfaceReconstruction + \ingroup PkgPoissonSurfaceReconstructionRef Performs surface reconstruction as follows: diff --git a/Polygon/doc/Polygon/PackageDescription.txt b/Polygon/doc/Polygon/PackageDescription.txt index 84e1a8d5c77..39c3596ffaa 100644 --- a/Polygon/doc/Polygon/PackageDescription.txt +++ b/Polygon/doc/Polygon/PackageDescription.txt @@ -1,20 +1,20 @@ -/// \defgroup PkgPolygon2 2D Polygon Reference +/// \defgroup PkgPolygon2Ref 2D Polygon Reference /// \defgroup PkgPolygon2Concepts Concepts -/// \ingroup PkgPolygon2 +/// \ingroup PkgPolygon2Ref /// \defgroup PkgPolygon2Functions Global Functions -/// \ingroup PkgPolygon2 +/// \ingroup PkgPolygon2Ref /*! -\addtogroup PkgPolygon2 +\addtogroup PkgPolygon2Ref \cgalPkgDescriptionBegin{2D Polygons,PkgPolygon2Summary} \cgalPkgPicture{polygon.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Geert-Jan Giezeman and Wieger Wesselink} \cgalPkgDesc{This package provides a 2D polygon class and operations on sequences of points, like bounding box, extremal points, signed area, simplicity and convexity test, orientation, and point location. The demo includes operations on polygons, such as computing a convex partition, and the straight skeleton.} -\cgalPkgManuals{Chapter_2D_Polygon,PkgPolygon2} +\cgalPkgManuals{Chapter_2D_Polygon,PkgPolygon2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{0.9} diff --git a/Polygon/include/CGAL/General_polygon_with_holes_2.h b/Polygon/include/CGAL/General_polygon_with_holes_2.h index 3e896d71c6f..b2d07098c02 100644 --- a/Polygon/include/CGAL/General_polygon_with_holes_2.h +++ b/Polygon/include/CGAL/General_polygon_with_holes_2.h @@ -33,7 +33,7 @@ namespace CGAL { /*! -\ingroup PkgPolygon2 +\ingroup PkgPolygon2Ref The class `General_polygon_with_holes_2` models the concept `GeneralPolygonWithHoles_2`. It represents a general polygon with diff --git a/Polygon/include/CGAL/Polygon_2.h b/Polygon/include/CGAL/Polygon_2.h index 443cefca305..e3458435161 100644 --- a/Polygon/include/CGAL/Polygon_2.h +++ b/Polygon/include/CGAL/Polygon_2.h @@ -49,7 +49,7 @@ namespace CGAL { -/// \ingroup PkgPolygon2 +/// \ingroup PkgPolygon2Ref /// The class Polygon_2 implements polygons. The Polygon_2 is /// parameterized by a traits class and a container class. The latter /// can be any class that fulfills the requirements for an STL diff --git a/Polygon/include/CGAL/Polygon_with_holes_2.h b/Polygon/include/CGAL/Polygon_with_holes_2.h index 0f63f43805d..70fcb52a4ee 100644 --- a/Polygon/include/CGAL/Polygon_with_holes_2.h +++ b/Polygon/include/CGAL/Polygon_with_holes_2.h @@ -34,7 +34,7 @@ namespace CGAL { /*! -\ingroup PkgPolygon2 +\ingroup PkgPolygon2Ref The class `Polygon_with_holes_2` models the concept `GeneralPolygonWithHoles_2`. It represents a linear polygon with holes. It is parameterized with two diff --git a/Polygon_mesh_processing/doc/Polygon_mesh_processing/NamedParameters.txt b/Polygon_mesh_processing/doc/Polygon_mesh_processing/NamedParameters.txt index 839bd7b52ff..87a4e4b0058 100644 --- a/Polygon_mesh_processing/doc/Polygon_mesh_processing/NamedParameters.txt +++ b/Polygon_mesh_processing/doc/Polygon_mesh_processing/NamedParameters.txt @@ -1,6 +1,6 @@ /*! \defgroup pmp_namedparameters Named Parameters for Polygon Mesh Processing -\ingroup PkgPolygonMeshProcessing +\ingroup PkgPolygonMeshProcessingRef In this package, all functions optional parameters are implemented as BGL optional named parameters (see \ref BGLNamedParameters for more information on how to use them). diff --git a/Polygon_mesh_processing/doc/Polygon_mesh_processing/PackageDescription.txt b/Polygon_mesh_processing/doc/Polygon_mesh_processing/PackageDescription.txt index 3baa705dad3..87b7e9d6954 100644 --- a/Polygon_mesh_processing/doc/Polygon_mesh_processing/PackageDescription.txt +++ b/Polygon_mesh_processing/doc/Polygon_mesh_processing/PackageDescription.txt @@ -1,6 +1,6 @@ -/// \defgroup PkgPolygonMeshProcessing Polygon Mesh Processing Reference +/// \defgroup PkgPolygonMeshProcessingRef Polygon Mesh Processing Reference /// \defgroup PkgPolygonMeshProcessingConcepts Concepts -/// \ingroup PkgPolygonMeshProcessing +/// \ingroup PkgPolygonMeshProcessingRef /// \defgroup keep_connected_components_grp Connected Components /// @@ -8,58 +8,58 @@ /// of adjacent faces such that all edges between two consecutive faces of the /// path are not marked as constrained. /// -/// \ingroup PkgPolygonMeshProcessing +/// \ingroup PkgPolygonMeshProcessingRef /// \defgroup hole_filling_grp Hole Filling /// Functions to fill holes given as a range of halfedges or as range of points. -/// \ingroup PkgPolygonMeshProcessing +/// \ingroup PkgPolygonMeshProcessingRef /// \defgroup PMP_meshing_grp Meshing /// Functions to triangulate faces, and to refine and fair regions of a polygon mesh. -/// \ingroup PkgPolygonMeshProcessing +/// \ingroup PkgPolygonMeshProcessingRef /// \defgroup PMP_normal_grp Normal Computation /// Functions to compute unit normals for individual/all vertices or faces. -/// \ingroup PkgPolygonMeshProcessing +/// \ingroup PkgPolygonMeshProcessingRef /// \defgroup measure_grp Geometric Measure Functions /// Functions to compute lengths of edges and borders, areas of faces and patches, as well as volumes of closed meshes. -/// \ingroup PkgPolygonMeshProcessing +/// \ingroup PkgPolygonMeshProcessingRef /// \defgroup PMP_orientation_grp Orientation Functions /// Functions to compute or change the orientation of faces and surfaces. -/// \ingroup PkgPolygonMeshProcessing +/// \ingroup PkgPolygonMeshProcessingRef /// \defgroup PMP_intersection_grp Intersection Functions /// Functions to test if there are self intersections, and to report faces that do intersect. -/// \ingroup PkgPolygonMeshProcessing +/// \ingroup PkgPolygonMeshProcessingRef /// \defgroup PMP_repairing_grp Combinatorial Repairing /// Functions to orient polygon soups and to stitch geometrically identical boundaries. -/// \ingroup PkgPolygonMeshProcessing +/// \ingroup PkgPolygonMeshProcessingRef /// \defgroup PMP_distance_grp Distance Functions /// Functions to compute the distance between meshes, between a mesh and a point set and between a point set and a mesh. -/// \ingroup PkgPolygonMeshProcessing +/// \ingroup PkgPolygonMeshProcessingRef /// \defgroup PMP_corefinement_grp Corefinement and Boolean Operations /// Functions to corefine triangulated surface meshes and compute triangulated /// surface meshes of the union, difference and intersection /// of the bounded volumes. -/// \ingroup PkgPolygonMeshProcessing +/// \ingroup PkgPolygonMeshProcessingRef /// \defgroup PMP_detect_features_grp Feature Detection Functions /// Functions to detect sharp edges and surface patches of polygon meshes. -/// \ingroup PkgPolygonMeshProcessing +/// \ingroup PkgPolygonMeshProcessingRef /// \defgroup PMP_predicates_grp Intersection Detection Functions /// Functions to detect intersections. /// Note that those functions will be exact as long as the underlying do-intersect predicates used are exact. /// In practice, it means that the 3D point type used must come from a \cgal kernel with exact predicates. -/// \ingroup PkgPolygonMeshProcessing +/// \ingroup PkgPolygonMeshProcessingRef /*! -\addtogroup PkgPolygonMeshProcessing +\addtogroup PkgPolygonMeshProcessingRef \cgalPkgDescriptionBegin{Polygon Mesh Processing, PkgPolygonMeshProcessingSummary} \cgalPkgPicture{hole_filling_ico.png} @@ -69,7 +69,7 @@ \cgalPkgDesc{This package provides a collection of methods and classes for polygon mesh processing, ranging from basic operations on simplices, to complex geometry processing algorithms.} -\cgalPkgManuals{Chapter_PolygonMeshProcessing,PkgPolygonMeshProcessing} +\cgalPkgManuals{Chapter_PolygonMeshProcessing,PkgPolygonMeshProcessingRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin diff --git a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/bbox.h b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/bbox.h index 0c73a8655dd..c3207e9acbb 100644 --- a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/bbox.h +++ b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/bbox.h @@ -39,7 +39,7 @@ namespace CGAL { namespace Polygon_mesh_processing { /*! - * \ingroup PkgPolygonMeshProcessing + * \ingroup PkgPolygonMeshProcessingRef * computes a bounding box of a polygon mesh. * * @tparam PolygonMesh a model of `HalfedgeListGraph` @@ -88,7 +88,7 @@ namespace CGAL { } /*! - * \ingroup PkgPolygonMeshProcessing + * \ingroup PkgPolygonMeshProcessingRef * computes a bounding box of a vertex of a polygon mesh. * * @tparam PolygonMesh a model of `HalfedgeGraph` @@ -131,7 +131,7 @@ namespace CGAL { } /*! - * \ingroup PkgPolygonMeshProcessing + * \ingroup PkgPolygonMeshProcessingRef * computes a bounding box of an edge of a polygon mesh. * * @tparam PolygonMesh a model of `HalfedgeGraph` @@ -175,7 +175,7 @@ namespace CGAL { } /*! - * \ingroup PkgPolygonMeshProcessing + * \ingroup PkgPolygonMeshProcessingRef * computes a bounding box of a face of a polygon mesh. * * @tparam PolygonMesh a model of `HalfedgeGraph` @@ -257,7 +257,7 @@ namespace CGAL { // deprecated function #ifndef CGAL_NO_DEPRECATED_CODE /*! - * \ingroup PkgPolygonMeshProcessing + * \ingroup PkgPolygonMeshProcessingRef * \deprecated This function is deprecated since \cgal 4.10, `CGAL::Polygon_mesh_processing::bbox()` should be used instead. */ template diff --git a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/border.h b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/border.h index 6c30cb6d077..91bc67d34be 100644 --- a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/border.h +++ b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/border.h @@ -147,7 +147,7 @@ namespace Polygon_mesh_processing { }//end namespace internal /*! - \ingroup PkgPolygonMeshProcessing + \ingroup PkgPolygonMeshProcessingRef * collects the border halfedges of a surface patch defined as a face range. * For each returned halfedge `h`, `opposite(h, pmesh)` belongs to a face of the patch, * but `face(h, pmesh)` does not belong to the patch. diff --git a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/transform.h b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/transform.h index efff419092c..cb2fac6ed76 100644 --- a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/transform.h +++ b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/transform.h @@ -28,7 +28,7 @@ namespace CGAL{ namespace Polygon_mesh_processing{ /** - * \ingroup PkgPolygonMeshProcessing + * \ingroup PkgPolygonMeshProcessingRef * applies a transformation to every vertex of a `PolygonMesh`. * * @tparam Transformation a functor that has an `operator()(Point_3)`, with `Point_3` diff --git a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_slicer.h b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_slicer.h index cda6a7e6c77..f667edeb8fe 100644 --- a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_slicer.h +++ b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_slicer.h @@ -44,7 +44,7 @@ namespace CGAL { -/// \ingroup PkgPolygonMeshProcessing +/// \ingroup PkgPolygonMeshProcessingRef /// Function object that computes the intersection of a plane with /// a triangulated surface mesh. /// diff --git a/Polygon_mesh_processing/include/CGAL/Side_of_triangle_mesh.h b/Polygon_mesh_processing/include/CGAL/Side_of_triangle_mesh.h index b59b027fd90..ef47a19a190 100644 --- a/Polygon_mesh_processing/include/CGAL/Side_of_triangle_mesh.h +++ b/Polygon_mesh_processing/include/CGAL/Side_of_triangle_mesh.h @@ -37,7 +37,7 @@ namespace CGAL { /** - * \ingroup PkgPolygonMeshProcessing + * \ingroup PkgPolygonMeshProcessingRef * This class provides an efficient point location functionality with respect to a domain bounded * by one or several disjoint closed triangle meshes. * diff --git a/Polygon_mesh_processing/include/CGAL/polygon_mesh_processing.h b/Polygon_mesh_processing/include/CGAL/polygon_mesh_processing.h index 7d587ad4b84..325abd04658 100644 --- a/Polygon_mesh_processing/include/CGAL/polygon_mesh_processing.h +++ b/Polygon_mesh_processing/include/CGAL/polygon_mesh_processing.h @@ -20,7 +20,7 @@ // Author(s) : Jane Tournois /** -* \ingroup PkgPolygonMeshProcessing +* \ingroup PkgPolygonMeshProcessingRef * \file CGAL/polygon_mesh_processing.h * Convenience header file including the headers for all * the free functions of this package. diff --git a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_3.h b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_3.h index 7d7b22d075f..47811036fd6 100644 --- a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_3.h +++ b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! - \ingroup PkgPolyhedron + \ingroup PkgPolyhedronRef A polyhedral surface `Polyhedron_3` consists of vertices `V`, edges `E`, facets `F` and an incidence relation on them. Each edge is @@ -114,7 +114,7 @@ class Polyhedron_3 { public: /*! - \ingroup PkgPolyhedron + \ingroup PkgPolyhedronRef A halfedge is an oriented edge between two vertices. It is always paired with a halfedge pointing in @@ -423,7 +423,7 @@ public: }; /* end Halfedge */ /*! - \ingroup PkgPolyhedron + \ingroup PkgPolyhedronRef A facet optionally stores a plane equation, and a reference to an incident halfedge that points to the facet. Type tags indicate whether @@ -600,7 +600,7 @@ public: }; /* end Facet */ /*! - \ingroup PkgPolyhedron + \ingroup PkgPolyhedronRef A vertex optionally stores a point and a reference to an incident halfedge that points to the vertex. Type tags indicate whether these diff --git a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_incremental_builder_3.h b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_incremental_builder_3.h index dc62a2a620f..8fbea2f7893 100644 --- a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_incremental_builder_3.h +++ b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_incremental_builder_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgPolyhedron +\ingroup PkgPolyhedronRef The auxiliary class `Polyhedron_incremental_builder_3` supports the incremental construction of polyhedral surfaces, which is for example convenient diff --git a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_items_3.h b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_items_3.h index a67ea634e7d..c4a2108545c 100644 --- a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_items_3.h +++ b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_items_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgPolyhedron +\ingroup PkgPolyhedronRef The class `Polyhedron_items_3` is a model of the `PolyhedronItems_3` concept. It provides definitions for vertices with points, halfedges, diff --git a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_min_items_3.h b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_min_items_3.h index 122d5d5ff96..441aaba4277 100644 --- a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_min_items_3.h +++ b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_min_items_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgPolyhedron +\ingroup PkgPolyhedronRef The class `Polyhedron_min_items_3` is a minimal model of the `PolyhedronItems_3` concept. It provides definitions for vertices diff --git a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_traits_3.h b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_traits_3.h index 68df4c08d0d..b112413c0b6 100644 --- a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_traits_3.h +++ b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_traits_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgPolyhedron +\ingroup PkgPolyhedronRef The class `Polyhedron_traits_3` is a model of the `PolyhedronTraits_3` concept. It defines the geometric types and primitive operations used diff --git a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_traits_with_normals_3.h b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_traits_with_normals_3.h index ab00f7f5e17..a99b689b63b 100644 --- a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_traits_with_normals_3.h +++ b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_traits_with_normals_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgPolyhedron +\ingroup PkgPolyhedronRef The class `Polyhedron_traits_with_normals_3` is a model of the `PolyhedronTraits_3` concept. It defines the geometric types and primitive operations used diff --git a/Polyhedron/doc/Polyhedron/PackageDescription.txt b/Polyhedron/doc/Polyhedron/PackageDescription.txt index 05972f40034..95e0c5ddf88 100644 --- a/Polyhedron/doc/Polyhedron/PackageDescription.txt +++ b/Polyhedron/doc/Polyhedron/PackageDescription.txt @@ -1,9 +1,9 @@ -/// \defgroup PkgPolyhedron 3D Polyhedral Surface Reference +/// \defgroup PkgPolyhedronRef 3D Polyhedral Surface Reference /// \defgroup PkgPolyhedronConcepts Concepts -/// \ingroup PkgPolyhedron +/// \ingroup PkgPolyhedronRef /// \defgroup PkgPolyhedronIOFunc I/O Functions -/// \ingroup PkgPolyhedron +/// \ingroup PkgPolyhedronRef /*! Draw. \code @@ -11,17 +11,17 @@ \endcode */ /// \defgroup PkgDrawPolyhedron Draw a Polyhedron 3 -/// \ingroup PkgPolyhedron +/// \ingroup PkgPolyhedronRef /*! -\addtogroup PkgPolyhedron +\addtogroup PkgPolyhedronRef \todo check generated documentation \cgalPkgDescriptionBegin{3D Polyhedral Surface,PkgPolyhedronSummary} \cgalPkgPicture{Polyhedron-teaser-small.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Lutz Kettner} \cgalPkgDesc{Polyhedral surfaces in three dimensions are composed of vertices, edges, facets and an incidence relationship on them. The organization beneath is a halfedge data structure, which restricts the class of representable surfaces to orientable 2-manifolds - with and without boundary. If the surface is closed we call it a polyhedron.} -\cgalPkgManuals{Chapter_3D_Polyhedral_Surfaces,PkgPolyhedron} +\cgalPkgManuals{Chapter_3D_Polyhedral_Surfaces,PkgPolyhedronRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{1.0} diff --git a/Polyline_simplification_2/doc/Polyline_simplification_2/PackageDescription.txt b/Polyline_simplification_2/doc/Polyline_simplification_2/PackageDescription.txt index 7a4b2f38fe7..6e5b9fcca6a 100644 --- a/Polyline_simplification_2/doc/Polyline_simplification_2/PackageDescription.txt +++ b/Polyline_simplification_2/doc/Polyline_simplification_2/PackageDescription.txt @@ -1,24 +1,24 @@ -/// \defgroup PkgPolylineSimplification2 2D Polyline Simplification Reference +/// \defgroup PkgPolylineSimplification2Ref 2D Polyline Simplification Reference /// \defgroup PkgPolylineSimplification2Concepts Concepts -/// \ingroup PkgPolylineSimplification2 +/// \ingroup PkgPolylineSimplification2Ref /// \defgroup PkgPolylineSimplification2Classes Polyline Simplification Classes -/// \ingroup PkgPolylineSimplification2 +/// \ingroup PkgPolylineSimplification2Ref /// \defgroup PkgPolylineSimplification2Functions Global Functions -/// \ingroup PkgPolylineSimplification2 +/// \ingroup PkgPolylineSimplification2Ref /*! -\addtogroup PkgPolylineSimplification2 +\addtogroup PkgPolylineSimplification2Ref \cgalPkgDescriptionBegin{2D Polyline Simplification,PkgPolylineSimplification2Summary} \cgalPkgPicture{PolylineSimplification-small.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Andreas Fabri} \cgalPkgDesc{This package enables to simplify polylines with the guarantee that the topology of the polylines does not change. This can be done for a single polyline as well as for a set of polyline constraints in a constrained triangulation. The simplification can be controlled with cost and stop functions.} -\cgalPkgManuals{Chapter_2D_Polyline_simplification,PkgPolylineSimplification2} +\cgalPkgManuals{Chapter_2D_Polyline_simplification,PkgPolylineSimplification2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{4.6} diff --git a/Polynomial/doc/Polynomial/PackageDescription.txt b/Polynomial/doc/Polynomial/PackageDescription.txt index e8ea1ffb953..d2036ebd27b 100644 --- a/Polynomial/doc/Polynomial/PackageDescription.txt +++ b/Polynomial/doc/Polynomial/PackageDescription.txt @@ -1,21 +1,21 @@ -/// \defgroup PkgPolynomial Polynomial Reference +/// \defgroup PkgPolynomialRef Polynomial Reference /// \defgroup PkgPolynomialConcepts Concepts -/// \ingroup PkgPolynomial +/// \ingroup PkgPolynomialRef /// \defgroup PkgPolynomialClasses Classes -/// \ingroup PkgPolynomial +/// \ingroup PkgPolynomialRef /// \defgroup PkgPolynomialFunctions Functions -/// \ingroup PkgPolynomial +/// \ingroup PkgPolynomialRef /*! -\addtogroup PkgPolynomial +\addtogroup PkgPolynomialRef \todo check generated documentation \cgalPkgDescriptionBegin{Polynomial,PkgPolynomialSummary} \cgalPkgPicture{Polynomial.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Michael Hemmer} \cgalPkgDesc{This package introduces a concept for univariate and multivariate polynomials in \f$ d\f$ variables. Though the concept is written for an arbitrary number of variables, the number of variables is considered as fixed for a particular model of this concept.} -\cgalPkgManuals{Chapter_Polynomial,PkgPolynomial} +\cgalPkgManuals{Chapter_Polynomial,PkgPolynomialRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.3} diff --git a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d.h b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d.h index d156904ed69..2322803b180 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d.h +++ b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgOptimalDistances +\ingroup PkgOptimalDistancesRef An object of the class `Polytope_distance_d` represents the (squared) distance between two convex polytopes, given as the convex hulls of two finite point diff --git a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_2.h b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_2.h index efe82888ec9..5692608860b 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_2.h +++ b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgOptimalDistances +\ingroup PkgOptimalDistancesRef The class `Polytope_distance_d_traits_2` is a traits class for the \f$ d\f$-dimensional optimisation algorithms using the two-dimensional \cgal kernel. diff --git a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_3.h b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_3.h index fdd520bd1b8..df36af390b7 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_3.h +++ b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgOptimalDistances +\ingroup PkgOptimalDistancesRef The class `Polytope_distance_d_traits_3` is a traits class for the \f$ d\f$-dimensional optimisation algorithms using the three-dimensional \cgal kernel. diff --git a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_d.h b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_d.h index 9749da82e48..808d76d850d 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_d.h +++ b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_d.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgOptimalDistances +\ingroup PkgOptimalDistancesRef The class `Polytope_distance_d_traits_d` is a traits class for the \f$ d\f$-dimensional optimisation algorithms using the \f$ d\f$-dimensional \cgal kernel. diff --git a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Width_3.h b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Width_3.h index faf013b2eb8..c9beaf62ab6 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Width_3.h +++ b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Width_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgOptimalDistances +\ingroup PkgOptimalDistancesRef Given a set of points \f$ \mathcal{S}=\left\{p_1,\ldots , p_n\right\}\f$ in \f$ \mathbb{R}^3\f$. The width of \f$ \mathcal{S}\f$, denoted as \f$ \mathcal{W(S)}\f$, is defined diff --git a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Width_default_traits_3.h b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Width_default_traits_3.h index c37cae8e2da..6e15580ba2b 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Width_default_traits_3.h +++ b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Width_default_traits_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgOptimalDistances +\ingroup PkgOptimalDistancesRef The class `Width_default_traits_3` is a traits class for `Width_3` using the three-dimensional \cgal kernel. 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 4688aeb2dad..ad42470ba56 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 @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgOptimalDistances +\ingroup PkgOptimalDistancesRef \brief computes all furthest neighbors for the vertices of the convex polygon described by the range [`points_begin`, `points_end`), writes diff --git a/Polytope_distance_d/doc/Polytope_distance_d/PackageDescription.txt b/Polytope_distance_d/doc/Polytope_distance_d/PackageDescription.txt index 21aa9b1fc34..d7cdc6df200 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/PackageDescription.txt +++ b/Polytope_distance_d/doc/Polytope_distance_d/PackageDescription.txt @@ -1,16 +1,16 @@ -/// \defgroup PkgOptimalDistances Optimal Distances Reference +/// \defgroup PkgOptimalDistancesRef Optimal Distances Reference /// \defgroup PkgOptimalDistancesConcepts Concepts -/// \ingroup PkgOptimalDistances +/// \ingroup PkgOptimalDistancesRef /*! -\addtogroup PkgOptimalDistances +\addtogroup PkgOptimalDistancesRef \todo check generated documentation \cgalPkgDescriptionBegin{Optimal Distances,PkgOptimalDistancesSummary} \cgalPkgPicture{dist.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Kaspar Fischer, Bernd Gärtner, Thomas Herrmann, Michael Hoffmann, and Sven Schönherr} \cgalPkgDesc{This package provides algorithms for computing the distance between the convex hulls of two point sets in d-dimensional space, without explicitely constructing the convex hulls. It further provides an algorithm to compute the width of a point set, and the furthest point for each vertex of a convex polygon. } -\cgalPkgManuals{Chapter_Optimal_Distances,PkgOptimalDistances} +\cgalPkgManuals{Chapter_Optimal_Distances,PkgOptimalDistancesRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{1.1} diff --git a/Principal_component_analysis/doc/Principal_component_analysis/PackageDescription.txt b/Principal_component_analysis/doc/Principal_component_analysis/PackageDescription.txt index 7ce6f967c15..42816fa6162 100644 --- a/Principal_component_analysis/doc/Principal_component_analysis/PackageDescription.txt +++ b/Principal_component_analysis/doc/Principal_component_analysis/PackageDescription.txt @@ -1,29 +1,29 @@ -/// \defgroup PkgPrincipalComponentAnalysisD Principal Component Analysis Reference +/// \defgroup PkgPrincipalComponentAnalysisDRef Principal Component Analysis Reference /// \defgroup PkgPrincipalComponentAnalysisDBary CGAL::barycenter() -/// \ingroup PkgPrincipalComponentAnalysisD +/// \ingroup PkgPrincipalComponentAnalysisDRef /// \defgroup PkgPrincipalComponentAnalysisDbb CGAL::bounding_box() -/// \ingroup PkgPrincipalComponentAnalysisD +/// \ingroup PkgPrincipalComponentAnalysisDRef /// \defgroup PkgPrincipalComponentAnalysisDCentroid CGAL::centroid() -/// \ingroup PkgPrincipalComponentAnalysisD +/// \ingroup PkgPrincipalComponentAnalysisDRef /// \defgroup PkgPrincipalComponentAnalysisDLLSF2 CGAL::linear_least_square_fitting_2() -/// \ingroup PkgPrincipalComponentAnalysisD +/// \ingroup PkgPrincipalComponentAnalysisDRef /// \defgroup PkgPrincipalComponentAnalysisDLLSF3 CGAL::linear_least_square_fitting_3() -/// \ingroup PkgPrincipalComponentAnalysisD +/// \ingroup PkgPrincipalComponentAnalysisDRef /*! -\addtogroup PkgPrincipalComponentAnalysisD +\addtogroup PkgPrincipalComponentAnalysisDRef \todo check generated documentation \cgalPkgDescriptionBegin{Principal Component Analysis,PkgPrincipalComponentAnalysisDSummary} \cgalPkgPicture{teaserLeastSquaresFitting.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Pierre Alliez, Sylvain Pion and Ankit Gupta} \cgalPkgDesc{This package provides functions to compute global information about the shape of a set of 2D or 3D objects. It provides the computation of axis-aligned bounding boxes for point sets, and barycenters of weighted point sets. In addition, it provides computation of centroids (center of mass) and linear least squares fitting for point sets as well as for sets of other bounded objects. More specifically, it is possible to fit 2D lines to 2D segments, circles, disks, iso rectangles and triangles, as well as to fit 3D lines or 3D planes to 3D segments, triangles, iso cuboids, tetrahedra, spheres and balls. The common interface to these functions takes an iterator range of objects.} -\cgalPkgManuals{Chapter_Principal_Component_Analysis,PkgPrincipalComponentAnalysisD} +\cgalPkgManuals{Chapter_Principal_Component_Analysis,PkgPrincipalComponentAnalysisDRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.2} diff --git a/Property_map/doc/Property_map/PackageDescription.txt b/Property_map/doc/Property_map/PackageDescription.txt index a768dfacd9b..100328d94c8 100644 --- a/Property_map/doc/Property_map/PackageDescription.txt +++ b/Property_map/doc/Property_map/PackageDescription.txt @@ -1,14 +1,14 @@ -/// \defgroup PkgProperty_map CGAL and Boost Property Maps Reference +/// \defgroup PkgProperty_mapRef CGAL and Boost Property Maps Reference /*! -\addtogroup PkgProperty_map +\addtogroup PkgProperty_mapRef \cgalPkgDescriptionBegin{CGAL and Boost Property Maps,PkgProperty_mapSummary} \cgalPkgPicture{property_map.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Andreas Fabri and Laurent Saboret} \cgalPkgDesc{This package provides a framework for interfacing \cgal data structures with algorithms expecting Boost Property Maps.} -\cgalPkgManuals{Chapter_CGAL_and_Boost_Property_Maps,PkgProperty_map} +\cgalPkgManuals{Chapter_CGAL_and_Boost_Property_Maps,PkgProperty_mapRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.5} diff --git a/Property_map/include/CGAL/property_map.h b/Property_map/include/CGAL/property_map.h index f589496dcba..0a63ec9dca6 100644 --- a/Property_map/include/CGAL/property_map.h +++ b/Property_map/include/CGAL/property_map.h @@ -169,7 +169,7 @@ struct Input_iterator_property_map{ get(Input_iterator_property_map,InputIterator it){ return *it; } }; -/// \ingroup PkgProperty_map +/// \ingroup PkgProperty_mapRef /// Property map that converts a `T*` pointer (or in general an iterator /// over `T` elements) to the `T` object. /// @@ -201,7 +201,7 @@ make_dereference_property_map(Iter) return Dereference_property_map::type>(); } -/// \ingroup PkgProperty_map +/// \ingroup PkgProperty_mapRef /// A `LvaluePropertyMap` property map mapping a key to itself (by reference). /// /// \cgalModels `LvaluePropertyMap` @@ -235,7 +235,7 @@ Identity_property_map } -/// \ingroup PkgProperty_map +/// \ingroup PkgProperty_mapRef /// Property map that accesses the first item of a `std::pair`. /// \tparam Pair Instance of `std::pair`. /// \cgalModels `LvaluePropertyMap` @@ -271,7 +271,7 @@ First_of_pair_property_map return First_of_pair_property_map(); } -/// \ingroup PkgProperty_map +/// \ingroup PkgProperty_mapRef /// /// Property map that accesses the second item of a `std::pair`. /// @@ -310,7 +310,7 @@ Second_of_pair_property_map return Second_of_pair_property_map(); } -/// \ingroup PkgProperty_map +/// \ingroup PkgProperty_mapRef /// /// Property map that accesses the Nth item of a `boost::tuple` or a `std::tuple`. /// @@ -370,7 +370,7 @@ Nth_of_tuple_property_map return Nth_of_tuple_property_map(); } -/// \ingroup PkgProperty_map +/// \ingroup PkgProperty_mapRef /// Struct that turns a property map into a unary functor with /// `operator()(key k)` calling the get function with `k` template @@ -391,7 +391,7 @@ struct Property_map_to_unary_function{ } }; -/// \ingroup PkgProperty_map +/// \ingroup PkgProperty_mapRef /// Utility class providing shortcuts to property maps based on raw pointers template struct Pointer_property_map{ @@ -405,7 +405,7 @@ struct Pointer_property_map{ const T&> const_type; ///< non-mutable `LvaluePropertyMap` }; -/// \ingroup PkgProperty_map +/// \ingroup PkgProperty_mapRef /// Starting from boost 1.55, the use of raw pointers as property maps has been deprecated. /// This function is a shortcut to the recommanded replacement: /// `boost::make_iterator_property_map(, boost::typed_identity_property_map())` @@ -418,7 +418,7 @@ make_property_map(T* pointer) return typename Pointer_property_map::type(pointer); } -/// \ingroup PkgProperty_map +/// \ingroup PkgProperty_mapRef /// equivalent to `make_property_map(&v[0])` /// Note that `v` must not be modified while using the property map created template @@ -432,7 +432,7 @@ make_property_map(std::vector& v) return make_property_map(&v[0]); } -/// \ingroup PkgProperty_map +/// \ingroup PkgProperty_mapRef /// Non-mutable version template inline @@ -442,7 +442,7 @@ make_property_map(const T* pointer) return typename Pointer_property_map::const_type(pointer); } -/// \ingroup PkgProperty_map +/// \ingroup PkgProperty_mapRef /// equivalent to `make_property_map(&v[0])` /// Note that `v` must not be modified while using the property map created template @@ -453,7 +453,7 @@ make_property_map(const std::vector& v) return make_property_map(&v[0]); } -/// \ingroup PkgProperty_map +/// \ingroup PkgProperty_mapRef /// Property map that returns a fixed value. /// Note that this value is chosen when the map is constructed and cannot /// be changed afterwards. Specifically, the free function `put()` does nothing. @@ -479,7 +479,7 @@ struct Constant_property_map put (const Constant_property_map&, const key_type&, const value_type&) { } }; -/// \ingroup PkgProperty_map +/// \ingroup PkgProperty_mapRef /// Read-write property map turning a set (such a `std::set`, /// `boost::unordered_set`, `std::unordered_set`) into a property map /// associating a Boolean to the value type of the set. The function `get` will @@ -517,7 +517,7 @@ struct Boolean_property_map } }; -/// \ingroup PkgProperty_map +/// \ingroup PkgProperty_mapRef /// returns `Boolean_property_map(set_)` template Boolean_property_map @@ -526,7 +526,7 @@ make_boolean_property_map(Set& set_) return Boolean_property_map(set_); } -/// \ingroup PkgProperty_map +/// \ingroup PkgProperty_mapRef /// Read-write property map doing on-the-fly conversions between two default constructible \cgal %Cartesian kernels. /// Its value type is `GeomObject` and its key type is the same as `Vpm`. /// `GeomObject` must be a geometric object from a \cgal kernel. @@ -561,7 +561,7 @@ struct Cartesian_converter_property_map } }; -/// \ingroup PkgProperty_map +/// \ingroup PkgProperty_mapRef /// returns `Cartesian_converter_property_map(vpm)` template Cartesian_converter_property_map diff --git a/QP_solver/doc/QP_solver/PackageDescription.txt b/QP_solver/doc/QP_solver/PackageDescription.txt index 401a802f8c4..5f136f6b41a 100644 --- a/QP_solver/doc/QP_solver/PackageDescription.txt +++ b/QP_solver/doc/QP_solver/PackageDescription.txt @@ -1,7 +1,7 @@ -/// \defgroup PkgQPSolver Linear and Quadratic Programming Solver Reference +/// \defgroup PkgQPSolverRef Linear and Quadratic Programming Solver Reference /*! \defgroup PkgQPSolverConcepts Concepts - \ingroup PkgQPSolver + \ingroup PkgQPSolverRef - `QuadraticProgram` (for quadratic programs with variable bounds \f$ l \leq x \leq u\f$) - `LinearProgram` (for linear programs with variable bounds \f$ l \leq x \leq u\f$) @@ -13,7 +13,7 @@ /*! \defgroup PkgQPSolverClasses Classes - \ingroup PkgQPSolver + \ingroup PkgQPSolverRef This module provides high and low level classes that allow to construct and represent linear and quadratic programs and their solution. @@ -39,7 +39,7 @@ Then there are specific models for any of the four program concepts above; these /*! \defgroup PkgQPSolverFunctions Functions - \ingroup PkgQPSolver + \ingroup PkgQPSolverRef This module provides makers to construct a program, as well as functions to solve and print programs. @@ -71,14 +71,14 @@ Programs can be written to an output stream in MPSFormat, using one of the follo */ /*! -\addtogroup PkgQPSolver +\addtogroup PkgQPSolverRef \todo check generated documentation \cgalPkgDescriptionBegin{Linear and Quadratic Programming Solver,PkgQPSolverSummary} \cgalPkgPicture{qp.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Kaspar Fischer, Bernd Gärtner, Sven Schönherr, and Frans Wessendorp} \cgalPkgDesc{This package contains algorithms for minimizing linear and convex quadratic functions over polyhedral domains, described by linear equations and inequalities. The algorithms are exact, i.e.\ the solution is computed in terms of multiprecision rational numbers. The resulting solution is certified: along with the claims that the problem under consideration has an optimal solution, is infeasible, or is unbounded, the algorithms also deliver proofs for these facts. These proofs can easily (and independently from the algorithms) be checked for correctness. The solution algorithms are based on a generalization of the simplex method to quadratic objective functions. } -\cgalPkgManuals{Chapter_Linear_and_Quadratic_Programming_Solver,PkgQPSolver} +\cgalPkgManuals{Chapter_Linear_and_Quadratic_Programming_Solver,PkgQPSolverRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.3} diff --git a/Ridges_3/doc/Ridges_3/CGAL/Ridges.h b/Ridges_3/doc/Ridges_3/CGAL/Ridges.h index 1c6cec82ad6..7f882b10726 100644 --- a/Ridges_3/doc/Ridges_3/CGAL/Ridges.h +++ b/Ridges_3/doc/Ridges_3/CGAL/Ridges.h @@ -24,7 +24,7 @@ enum Ridge_type { /*! -\ingroup PkgRidges_3 +\ingroup PkgRidges_3Ref The function `compute_crest_ridges()` is a shortcut to the method `Ridge_approximation::compute_crest_ridges()`. @@ -53,7 +53,7 @@ OutputIterator compute_crest_ridges(const TriangleMesh &tm, namespace CGAL { /*! -\ingroup PkgRidges_3 +\ingroup PkgRidges_3Ref The function `compute_max_ridges()` is a shortcut to the method `Ridge_approximation::compute_max_ridges()`. @@ -80,7 +80,7 @@ OutputIterator compute_max_ridges(const TriangleMesh &tm, namespace CGAL { /*! -\ingroup PkgRidges_3 +\ingroup PkgRidges_3Ref The function `compute_min_ridges()` is a shortcut to the method `Ridge_approximation::compute_min_ridges()`. @@ -110,7 +110,7 @@ OutputIterator compute_min_ridges(const TriangleMesh &tm, namespace CGAL { /*! -\ingroup PkgRidges_3 +\ingroup PkgRidges_3Ref The class `Ridge_approximation` computes the approximation of ridges of a triangular polyhedral surface. @@ -194,7 +194,7 @@ template OutputIterator compute_crest_ridges(OutputIterat namespace CGAL { /*! -\ingroup PkgRidges_3 +\ingroup PkgRidges_3Ref The class `Ridge_line` stores the description of a ridge line. The list of halfedges defines a connected sequence of edges (but not as diff --git a/Ridges_3/doc/Ridges_3/CGAL/Umbilics.h b/Ridges_3/doc/Ridges_3/CGAL/Umbilics.h index 2b791415ca2..eaa1d8e1a5a 100644 --- a/Ridges_3/doc/Ridges_3/CGAL/Umbilics.h +++ b/Ridges_3/doc/Ridges_3/CGAL/Umbilics.h @@ -9,7 +9,7 @@ enum Umbilic_type { NON_GENERIC_UMBILIC, ELLIPTIC_UMBILIC, HYPERBOLIC_UMBILIC }; /*! -\ingroup PkgRidges_3 +\ingroup PkgRidges_3Ref The function `compute_umbilics()` is a shortcut to the method `Umbilic_approximation::compute()`. See `Umbilic_approximation::Umbilic_approximation()` for an explanation of the parameters. @@ -34,7 +34,7 @@ double size); namespace CGAL { /*! -\ingroup PkgRidges_3 +\ingroup PkgRidges_3Ref The class `Umbilic_approximation` computes the approximation of umbilics on a triangular polyhedral surface. @@ -109,7 +109,7 @@ template OutputIterator compute(OutputIterator it, FT siz namespace CGAL { /*! -\ingroup PkgRidges_3 +\ingroup PkgRidges_3Ref The class `Umbilic` stores the description of an umbilic. diff --git a/Ridges_3/doc/Ridges_3/PackageDescription.txt b/Ridges_3/doc/Ridges_3/PackageDescription.txt index 41da0e8439c..31774bc9931 100644 --- a/Ridges_3/doc/Ridges_3/PackageDescription.txt +++ b/Ridges_3/doc/Ridges_3/PackageDescription.txt @@ -1,17 +1,17 @@ -/// \defgroup PkgRidges_3 Approximation of Ridges and Umbilics on Triangulated Surface Meshes Reference +/// \defgroup PkgRidges_3Ref Approximation of Ridges and Umbilics on Triangulated Surface Meshes Reference /// \defgroup PkgRidges_3Enums Enums -/// \ingroup PkgRidges_3 +/// \ingroup PkgRidges_3Ref /*! -\addtogroup PkgRidges_3 +\addtogroup PkgRidges_3Ref \todo check generated documentation \cgalPkgDescriptionBegin{Approximation of Ridges and Umbilics on Triangulated Surface Meshes,PkgRidges_3Summary} \cgalPkgPicture{RidgesMechPartDetail.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Marc Pouget and Frédéric Cazals} \cgalPkgDesc{Global features related to curvature extrema encode important informations used in segmentation, registration, matching and surface analysis. Given pointwise estimations of local differential quantities, this package allows the approximation of differential features on a triangulated surface mesh. Such curvature related features are curves: ridges or crests, and points: umbilics.} -\cgalPkgManuals{Chapter_Approximation_of_Ridges_and_Umbilics_on_Triangulated_Surface_Meshes,PkgRidges_3} +\cgalPkgManuals{Chapter_Approximation_of_Ridges_and_Umbilics_on_Triangulated_Surface_Meshes,PkgRidges_3Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.3} diff --git a/STL_Extension/doc/STL_Extension/CGAL/CC_safe_handle.h b/STL_Extension/doc/STL_Extension/CGAL/CC_safe_handle.h index 8b1f42a1eb8..34d6767c387 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/CC_safe_handle.h +++ b/STL_Extension/doc/STL_Extension/CGAL/CC_safe_handle.h @@ -1,7 +1,7 @@ namespace CGAL { -/// \ingroup PkgStlExtension +/// \ingroup PkgStlExtensionRef /*! \ingroup CompactContainer diff --git a/STL_Extension/doc/STL_Extension/CGAL/Compact_container.h b/STL_Extension/doc/STL_Extension/CGAL/Compact_container.h index 66887daa22f..d7ef04fcafb 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/Compact_container.h +++ b/STL_Extension/doc/STL_Extension/CGAL/Compact_container.h @@ -2,7 +2,7 @@ namespace CGAL { /// \defgroup CompactContainer Compact Container -/// \ingroup PkgStlExtension +/// \ingroup PkgStlExtensionRef /*! \ingroup CompactContainer diff --git a/STL_Extension/doc/STL_Extension/CGAL/Concurrent_compact_container.h b/STL_Extension/doc/STL_Extension/CGAL/Concurrent_compact_container.h index e358e5788f6..8732316de17 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/Concurrent_compact_container.h +++ b/STL_Extension/doc/STL_Extension/CGAL/Concurrent_compact_container.h @@ -1,7 +1,7 @@ namespace CGAL { -/// \ingroup PkgStlExtension +/// \ingroup PkgStlExtensionRef /*! \ingroup CompactContainer diff --git a/STL_Extension/doc/STL_Extension/CGAL/Default.h b/STL_Extension/doc/STL_Extension/CGAL/Default.h index ccd301b0c2e..6939f93b2de 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/Default.h +++ b/STL_Extension/doc/STL_Extension/CGAL/Default.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgStlExtension +\ingroup PkgStlExtensionRef diff --git a/STL_Extension/doc/STL_Extension/CGAL/In_place_list.h b/STL_Extension/doc/STL_Extension/CGAL/In_place_list.h index d0aa69ce56b..5bc32a5602e 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/In_place_list.h +++ b/STL_Extension/doc/STL_Extension/CGAL/In_place_list.h @@ -1,5 +1,5 @@ /// \defgroup inplacelist Doubly-Connected List Managing Items in Place -/// \ingroup PkgStlExtension +/// \ingroup PkgStlExtensionRef namespace CGAL { diff --git a/STL_Extension/doc/STL_Extension/CGAL/Iterator_range.h b/STL_Extension/doc/STL_Extension/CGAL/Iterator_range.h index ba96dbaa48e..457f0ddd955 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/Iterator_range.h +++ b/STL_Extension/doc/STL_Extension/CGAL/Iterator_range.h @@ -27,7 +27,7 @@ namespace CGAL { /*! - \ingroup PkgStlExtension + \ingroup PkgStlExtensionRef `CGAL::Iterator_range` encapsulates two iterators so they fulfill the `ForwardRange` concept. The class is essentially a clone of `boost::iterator_range`, and it additionally is derived from `std::pair`, so that one can apply `boost::tie`. diff --git a/STL_Extension/doc/STL_Extension/CGAL/Multiset.h b/STL_Extension/doc/STL_Extension/CGAL/Multiset.h index 833c51dff9a..233032e5345 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/Multiset.h +++ b/STL_Extension/doc/STL_Extension/CGAL/Multiset.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgStlExtension +\ingroup PkgStlExtensionRef \anchor classcgal_multimap diff --git a/STL_Extension/doc/STL_Extension/CGAL/Object.h b/STL_Extension/doc/STL_Extension/CGAL/Object.h index 27f21b9212d..88dc3a5ac64 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/Object.h +++ b/STL_Extension/doc/STL_Extension/CGAL/Object.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgStlExtension +\ingroup PkgStlExtensionRef Some functions can return different types of objects. A typical \cpp solution to this problem is to derive all possible return diff --git a/STL_Extension/doc/STL_Extension/CGAL/Spatial_lock_grid_3.h b/STL_Extension/doc/STL_Extension/CGAL/Spatial_lock_grid_3.h index c0e4b5edfa4..118d3a4f227 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/Spatial_lock_grid_3.h +++ b/STL_Extension/doc/STL_Extension/CGAL/Spatial_lock_grid_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgStlExtension +\ingroup PkgStlExtensionRef The class `Spatial_lock_grid_3` allows to lock points with coordinates (x, y, z) in a 3D grid. diff --git a/STL_Extension/doc/STL_Extension/CGAL/algorithm.h b/STL_Extension/doc/STL_Extension/CGAL/algorithm.h index c0a74209c71..a915d057a3e 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/algorithm.h +++ b/STL_Extension/doc/STL_Extension/CGAL/algorithm.h @@ -1,5 +1,5 @@ /// \defgroup STLAlgos Generic Algorithms -/// \ingroup PkgStlExtension +/// \ingroup PkgStlExtensionRef namespace CGAL { diff --git a/STL_Extension/doc/STL_Extension/CGAL/array.h b/STL_Extension/doc/STL_Extension/CGAL/array.h index 15660adb630..5f35cb9607a 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/array.h +++ b/STL_Extension/doc/STL_Extension/CGAL/array.h @@ -2,7 +2,7 @@ namespace CGAL { namespace cpp11 { /*! -\ingroup PkgStlExtension +\ingroup PkgStlExtensionRef An object of the class `cpp11::array` represents an array of elements of type `T`, the number of which is specified by the second template argument. diff --git a/STL_Extension/doc/STL_Extension/CGAL/function.h b/STL_Extension/doc/STL_Extension/CGAL/function.h index cf5433d971d..842d1422374 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/function.h +++ b/STL_Extension/doc/STL_Extension/CGAL/function.h @@ -2,7 +2,7 @@ namespace CGAL { namespace cpp11 { /*! -\ingroup PkgStlExtension +\ingroup PkgStlExtensionRef An object of the class `cpp11::function` is a general-purpose polymorphic function wrapper. diff --git a/STL_Extension/doc/STL_Extension/CGAL/function_objects.h b/STL_Extension/doc/STL_Extension/CGAL/function_objects.h index 997cf54dd4c..196add3b710 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/function_objects.h +++ b/STL_Extension/doc/STL_Extension/CGAL/function_objects.h @@ -1,5 +1,5 @@ /// \defgroup projectionobjects Projection Function Objects -/// \ingroup PkgStlExtension +/// \ingroup PkgStlExtensionRef namespace CGAL { @@ -138,7 +138,7 @@ compare_to_less(const F& f); /// \defgroup STLCreators Creator Function Objects -/// \ingroup PkgStlExtension +/// \ingroup PkgStlExtensionRef namespace CGAL { diff --git a/STL_Extension/doc/STL_Extension/CGAL/iterator.h b/STL_Extension/doc/STL_Extension/CGAL/iterator.h index 6291a81be44..68d5b274be5 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/iterator.h +++ b/STL_Extension/doc/STL_Extension/CGAL/iterator.h @@ -1,5 +1,5 @@ /// \defgroup STLIterators Iterators and Iterator/Circulator Adaptors -/// \ingroup PkgStlExtension +/// \ingroup PkgStlExtensionRef namespace CGAL { diff --git a/STL_Extension/doc/STL_Extension/CGAL/memory.h b/STL_Extension/doc/STL_Extension/CGAL/memory.h index 5a9f02b663a..4d5afc39d5b 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/memory.h +++ b/STL_Extension/doc/STL_Extension/CGAL/memory.h @@ -1,7 +1,7 @@ #include /** - * \ingroup PkgStlExtension + * \ingroup PkgStlExtensionRef * * A define for the allocator used by %CGAL. This is only defined if * there is no user defined version before `memory.h` is included diff --git a/STL_Extension/doc/STL_Extension/CGAL/result_of.h b/STL_Extension/doc/STL_Extension/CGAL/result_of.h index b39244044e2..d15a9db5bb4 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/result_of.h +++ b/STL_Extension/doc/STL_Extension/CGAL/result_of.h @@ -2,7 +2,7 @@ namespace CGAL { namespace cpp11 { /*! - \ingroup PkgStlExtension + \ingroup PkgStlExtensionRef Alias to the tr1 implementation from boost of the `result_of` mechanism. When all compilers supported by %CGAL will have a Standard compliant implemention of the the \cpp11 `decltype` feature, it will become an alias to std::result_of. diff --git a/STL_Extension/doc/STL_Extension/CGAL/tuple.h b/STL_Extension/doc/STL_Extension/CGAL/tuple.h index 4d7f15eea1d..56e27c2ec45 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/tuple.h +++ b/STL_Extension/doc/STL_Extension/CGAL/tuple.h @@ -3,7 +3,7 @@ namespace CGAL { namespace cpp11 { /*! -\ingroup PkgStlExtension +\ingroup PkgStlExtensionRef diff --git a/STL_Extension/doc/STL_Extension/PackageDescription.txt b/STL_Extension/doc/STL_Extension/PackageDescription.txt index 1c3c8a18f10..2717cce3dda 100644 --- a/STL_Extension/doc/STL_Extension/PackageDescription.txt +++ b/STL_Extension/doc/STL_Extension/PackageDescription.txt @@ -1,23 +1,23 @@ -/// \defgroup PkgStlExtension STL Extensions for CGAL Reference +/// \defgroup PkgStlExtensionRef STL Extensions for CGAL Reference /// \defgroup PkgStlExtensionConcepts Concepts -/// \ingroup PkgStlExtension +/// \ingroup PkgStlExtensionRef /// \defgroup PkgStlExtensionUtilities Utilities -/// \ingroup PkgStlExtension +/// \ingroup PkgStlExtensionRef /// \defgroup PkgStlExtensionAssertions Assertions and Failure Behaviour -/// \ingroup PkgStlExtension +/// \ingroup PkgStlExtensionRef /*! -\addtogroup PkgStlExtension +\addtogroup PkgStlExtensionRef \cgalPkgDescriptionBegin{STL Extensions for CGAL,PkgStlExtensionSummary} \cgalPkgPicture{plusplus.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Michael Hoffmann, Lutz Kettner, Sylvain Pion, and Ron Wein} \cgalPkgDesc{\cgal is designed in the spirit of the generic programming paradigm to work together with the Standard Template Library (\stl). This package provides non-geometric \stl-like algorithms and datastructures that are not in the \stl standard, as well as functions to change the failure behaviour of assertions.} -\cgalPkgManuals{Chapter_STL_Extensions_for_CGAL,PkgStlExtension} +\cgalPkgManuals{Chapter_STL_Extensions_for_CGAL,PkgStlExtensionRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{1.0} diff --git a/STL_Extension/include/CGAL/Iterator_range.h b/STL_Extension/include/CGAL/Iterator_range.h index 677aa9c44d2..5f1eb07ad1e 100644 --- a/STL_Extension/include/CGAL/Iterator_range.h +++ b/STL_Extension/include/CGAL/Iterator_range.h @@ -28,7 +28,7 @@ namespace CGAL { /*! -\ingroup PkgStlExtension +\ingroup PkgStlExtensionRef /// `CGAL::Iterator_range` is a... */ template diff --git a/STL_Extension/include/CGAL/value_type_traits.h b/STL_Extension/include/CGAL/value_type_traits.h index e50fc7de38b..31451fa6a38 100644 --- a/STL_Extension/include/CGAL/value_type_traits.h +++ b/STL_Extension/include/CGAL/value_type_traits.h @@ -26,7 +26,7 @@ namespace CGAL { -/// \ingroup PkgStlExtension +/// \ingroup PkgStlExtensionRef /// Class providing the value type of an iterator, and /// in the case of an output iterator, a type of objects that can be put in it. /// diff --git a/Scale_space_reconstruction_3/doc/Scale_space_reconstruction_3/PackageDescription.txt b/Scale_space_reconstruction_3/doc/Scale_space_reconstruction_3/PackageDescription.txt index a39837cd67e..959b2bd0a7d 100644 --- a/Scale_space_reconstruction_3/doc/Scale_space_reconstruction_3/PackageDescription.txt +++ b/Scale_space_reconstruction_3/doc/Scale_space_reconstruction_3/PackageDescription.txt @@ -1,20 +1,20 @@ -/// \defgroup PkgScaleSpaceReconstruction3 Scale-Space Surface Reconstruction Reference +/// \defgroup PkgScaleSpaceReconstruction3Ref Scale-Space Surface Reconstruction Reference /// \defgroup PkgScaleSpaceReconstruction3Concepts Concepts -/// \ingroup PkgScaleSpaceReconstruction3 +/// \ingroup PkgScaleSpaceReconstruction3Ref /// \defgroup PkgScaleSpaceReconstruction3Classes Classes -/// \ingroup PkgScaleSpaceReconstruction3 +/// \ingroup PkgScaleSpaceReconstruction3Ref /*! -\addtogroup PkgScaleSpaceReconstruction3 +\addtogroup PkgScaleSpaceReconstruction3Ref \cgalPkgDescriptionBegin{Scale-Space Surface Reconstruction,PkgScaleSpaceReconstruction3Summary} \cgalPkgPicture{knot_thumb.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Thijs van Lankveld} \cgalPkgDesc{This method allows to reconstruct a surface that interpolates a set of 3D points using either and alpha shape or the advancing front surface reconstruction method. The output interpolates the point set (as opposed to approximating the point set). How the surface connects the points depends on a scale variable, which can be estimated semi-automatically.} -\cgalPkgManuals{Chapter_Scale_space_reconstruction,PkgScaleSpaceReconstruction3} +\cgalPkgManuals{Chapter_Scale_space_reconstruction,PkgScaleSpaceReconstruction3Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{4.6} diff --git a/SearchStructures/doc/SearchStructures/CGAL/Tree_base.h b/SearchStructures/doc/SearchStructures/CGAL/Tree_base.h index 6feffa1d1b4..7197381e62f 100644 --- a/SearchStructures/doc/SearchStructures/CGAL/Tree_base.h +++ b/SearchStructures/doc/SearchStructures/CGAL/Tree_base.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgRangeSegmentTreesD +\ingroup PkgRangeSegmentTreesDRef `Tree_anchor` is also derived from `Tree_base`. Therefore, it provides the same methods as `Range_tree_d` and `Segment_tree_d`, but does diff --git a/SearchStructures/doc/SearchStructures/PackageDescription.txt b/SearchStructures/doc/SearchStructures/PackageDescription.txt index e6f3cd1a575..12b775c081e 100644 --- a/SearchStructures/doc/SearchStructures/PackageDescription.txt +++ b/SearchStructures/doc/SearchStructures/PackageDescription.txt @@ -1,22 +1,22 @@ -/// \defgroup PkgRangeSegmentTreesD dD Range and Segment Trees Reference +/// \defgroup PkgRangeSegmentTreesDRef dD Range and Segment Trees Reference /// \defgroup PkgRangeSegmentTreesDConcepts Concepts -/// \ingroup PkgRangeSegmentTreesD +/// \ingroup PkgRangeSegmentTreesDRef /// \defgroup PkgRangeSegmentTreesDTraitsClasses Traits Classes -/// \ingroup PkgRangeSegmentTreesD +/// \ingroup PkgRangeSegmentTreesDRef /// \defgroup PkgRangeSegmentTreesDSearchStructure Search Structures -/// \ingroup PkgRangeSegmentTreesD +/// \ingroup PkgRangeSegmentTreesDRef /*! -\addtogroup PkgRangeSegmentTreesD +\addtogroup PkgRangeSegmentTreesDRef \todo check generated documentation \cgalPkgDescriptionBegin{dD Range and Segment Trees,PkgRangeSegmentTreesDSummary} \cgalPkgPicture{segment_tree.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Gabriele Neyer} \cgalPkgDesc{%Range and segment trees allow to perform window queries on point sets, and to enumerate all ranges enclosing a query point. The provided data structures are static and they are optimized for fast queries.} -\cgalPkgManuals{Chapter_dD_Range_and_Segment_Trees,PkgRangeSegmentTreesD} +\cgalPkgManuals{Chapter_dD_Range_and_Segment_Trees,PkgRangeSegmentTreesDRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{0.9} diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_2.h index b027e98202f..88f940e398f 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgSegmentDelaunayGraph2 +\ingroup PkgSegmentDelaunayGraph2Ref The class `Segment_Delaunay_graph_2` represents the segment Delaunay graph (which is the dual graph of the 2D segment Voronoi diagram). diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_filtered_traits_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_filtered_traits_2.h index efe1816766d..eabca2b1001 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_filtered_traits_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_filtered_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgSegmentDelaunayGraph2 +\ingroup PkgSegmentDelaunayGraph2Ref The class `Segment_Delaunay_graph_filtered_traits_2` provides a model for the `SegmentDelaunayGraphTraits_2` concept. @@ -150,7 +150,7 @@ typedef unspecified_type Exact_traits; namespace CGAL { /*! -\ingroup PkgSegmentDelaunayGraph2 +\ingroup PkgSegmentDelaunayGraph2Ref The class `Segment_Delaunay_graph_filtered_traits_without_intersections_2` provides a model for the `SegmentDelaunayGraphTraits_2` concept. diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_hierarchy_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_hierarchy_2.h index fed2677c2ee..4e60298c8af 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_hierarchy_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_hierarchy_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgSegmentDelaunayGraph2 +\ingroup PkgSegmentDelaunayGraph2Ref We provide an alternative to the class `Segment_Delaunay_graph_2` for the incremental diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_hierarchy_vertex_base_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_hierarchy_vertex_base_2.h index 14c07257944..91b29a16620 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_hierarchy_vertex_base_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_hierarchy_vertex_base_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgSegmentDelaunayGraph2 +\ingroup PkgSegmentDelaunayGraph2Ref The class `Segment_Delaunay_graph_hierarchy_vertex_base_2` provides a model for the `SegmentDelaunayGraphHierarchyVertexBase_2` concept, which is the diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_site_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_site_2.h index 8453319b95e..5a9ac423e12 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_site_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_site_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgSegmentDelaunayGraph2 +\ingroup PkgSegmentDelaunayGraph2Ref The class `Segment_Delaunay_graph_site_2` is a model for the concept `SegmentDelaunayGraphSite_2`. diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_storage_site_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_storage_site_2.h index 5b51c5e4360..0b76d67103f 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_storage_site_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_storage_site_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgSegmentDelaunayGraph2 +\ingroup PkgSegmentDelaunayGraph2Ref The class `Segment_Delaunay_graph_storage_site_2` is a model for the concept `SegmentDelaunayGraphStorageSite_2`. diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_traits_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_traits_2.h index 5d915262170..ec45c0ff065 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_traits_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgSegmentDelaunayGraph2 +\ingroup PkgSegmentDelaunayGraph2Ref The class `Segment_Delaunay_graph_traits_2` provides a model for the `SegmentDelaunayGraphTraits_2` concept. @@ -74,7 +74,7 @@ typedef MTag Method_tag; namespace CGAL { /*! -\ingroup PkgSegmentDelaunayGraph2 +\ingroup PkgSegmentDelaunayGraph2Ref The class `Segment_Delaunay_graph_traits_without_intersections_2` provides a model for the `SegmentDelaunayGraphTraits_2` concept. diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_vertex_base_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_vertex_base_2.h index dfd1c5ef860..8b35879a460 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_vertex_base_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_vertex_base_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgSegmentDelaunayGraph2 +\ingroup PkgSegmentDelaunayGraph2Ref The class `Segment_Delaunay_graph_vertex_base_2` provides a model for the `SegmentDelaunayGraphVertexBase_2` concept which is the vertex diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/PackageDescription.txt b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/PackageDescription.txt index ad569d97e61..78913698102 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/PackageDescription.txt +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/PackageDescription.txt @@ -1,15 +1,15 @@ -/// \defgroup PkgSegmentDelaunayGraph2 2D Segment Delaunay Graphs Reference +/// \defgroup PkgSegmentDelaunayGraph2Ref 2D Segment Delaunay Graphs Reference /// \defgroup PkgSegmentDelaunayGraph2Concepts Concepts -/// \ingroup PkgSegmentDelaunayGraph2 +/// \ingroup PkgSegmentDelaunayGraph2Ref /*! -\addtogroup PkgSegmentDelaunayGraph2 +\addtogroup PkgSegmentDelaunayGraph2Ref \todo check generated documentation \cgalPkgDescriptionBegin{2D Segment Delaunay Graphs,PkgSegmentDelaunayGraph2Summary} \cgalPkgPicture{svd.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Menelaos Karavelas} \cgalPkgDesc{An algorithm for computing the dual of a Voronoi diagram of a set of segments under the Euclidean metric. It is a generalization of the standard Voronoi diagram for points. The algorithms provided are dynamic.} -\cgalPkgManuals{Chapter_2D_Segment_Delaunay_Graphs,PkgSegmentDelaunayGraph2} +\cgalPkgManuals{Chapter_2D_Segment_Delaunay_Graphs,PkgSegmentDelaunayGraph2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.1} diff --git a/Segment_Delaunay_graph_Linf_2/doc/Segment_Delaunay_graph_Linf_2/CGAL/Segment_Delaunay_graph_Linf_2.h b/Segment_Delaunay_graph_Linf_2/doc/Segment_Delaunay_graph_Linf_2/CGAL/Segment_Delaunay_graph_Linf_2.h index e42b0215104..162c139da59 100644 --- a/Segment_Delaunay_graph_Linf_2/doc/Segment_Delaunay_graph_Linf_2/CGAL/Segment_Delaunay_graph_Linf_2.h +++ b/Segment_Delaunay_graph_Linf_2/doc/Segment_Delaunay_graph_Linf_2/CGAL/Segment_Delaunay_graph_Linf_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgSDGLinf +\ingroup PkgSDGLinfRef The class `Segment_Delaunay_graph_Linf_2` represents the segment Delaunay graph under the \f$ L_{\infty} \f$ metric (which is diff --git a/Segment_Delaunay_graph_Linf_2/doc/Segment_Delaunay_graph_Linf_2/CGAL/Segment_Delaunay_graph_Linf_filtered_traits_2.h b/Segment_Delaunay_graph_Linf_2/doc/Segment_Delaunay_graph_Linf_2/CGAL/Segment_Delaunay_graph_Linf_filtered_traits_2.h index 8ed68312025..6111e8bed87 100644 --- a/Segment_Delaunay_graph_Linf_2/doc/Segment_Delaunay_graph_Linf_2/CGAL/Segment_Delaunay_graph_Linf_filtered_traits_2.h +++ b/Segment_Delaunay_graph_Linf_2/doc/Segment_Delaunay_graph_Linf_2/CGAL/Segment_Delaunay_graph_Linf_filtered_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgSDGLinf +\ingroup PkgSDGLinfRef The class `Segment_Delaunay_graph_Linf_filtered_traits_2` provides a model for the `SegmentDelaunayGraphLinfTraits_2` concept. @@ -34,7 +34,7 @@ struct Segment_Delaunay_graph_Linf_filtered_traits_2 { namespace CGAL { /*! -\ingroup PkgSDGLinf +\ingroup PkgSDGLinfRef The class `Segment_Delaunay_graph_Linf_filtered_traits_without_intersections_2` provides a model for the diff --git a/Segment_Delaunay_graph_Linf_2/doc/Segment_Delaunay_graph_Linf_2/CGAL/Segment_Delaunay_graph_Linf_hierarchy_2.h b/Segment_Delaunay_graph_Linf_2/doc/Segment_Delaunay_graph_Linf_2/CGAL/Segment_Delaunay_graph_Linf_hierarchy_2.h index 3242e220287..e823186116c 100644 --- a/Segment_Delaunay_graph_Linf_2/doc/Segment_Delaunay_graph_Linf_2/CGAL/Segment_Delaunay_graph_Linf_hierarchy_2.h +++ b/Segment_Delaunay_graph_Linf_2/doc/Segment_Delaunay_graph_Linf_2/CGAL/Segment_Delaunay_graph_Linf_hierarchy_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgSDGLinf +\ingroup PkgSDGLinfRef This class is equivalent to the `Segment_Delaunay_graph_hierarchy_2` class, but it uses `Segment_Delaunay_graph_Linf_2` diff --git a/Segment_Delaunay_graph_Linf_2/doc/Segment_Delaunay_graph_Linf_2/CGAL/Segment_Delaunay_graph_Linf_traits_2.h b/Segment_Delaunay_graph_Linf_2/doc/Segment_Delaunay_graph_Linf_2/CGAL/Segment_Delaunay_graph_Linf_traits_2.h index d5e21605e23..1c0c752aad1 100644 --- a/Segment_Delaunay_graph_Linf_2/doc/Segment_Delaunay_graph_Linf_2/CGAL/Segment_Delaunay_graph_Linf_traits_2.h +++ b/Segment_Delaunay_graph_Linf_2/doc/Segment_Delaunay_graph_Linf_2/CGAL/Segment_Delaunay_graph_Linf_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgSDGLinf +\ingroup PkgSDGLinfRef The class `Segment_Delaunay_graph_Linf_traits_2` provides a model for the `SegmentDelaunayGraphLinfTraits_2` concept. @@ -36,7 +36,7 @@ struct Segment_Delaunay_graph_Linf_traits_2 { namespace CGAL { /*! -\ingroup PkgSDGLinf +\ingroup PkgSDGLinfRef The class `Segment_Delaunay_graph_Linf_traits_without_intersections_2` provides a model for the diff --git a/Segment_Delaunay_graph_Linf_2/doc/Segment_Delaunay_graph_Linf_2/PackageDescription.txt b/Segment_Delaunay_graph_Linf_2/doc/Segment_Delaunay_graph_Linf_2/PackageDescription.txt index 52b93543f4b..9218294b077 100644 --- a/Segment_Delaunay_graph_Linf_2/doc/Segment_Delaunay_graph_Linf_2/PackageDescription.txt +++ b/Segment_Delaunay_graph_Linf_2/doc/Segment_Delaunay_graph_Linf_2/PackageDescription.txt @@ -1,9 +1,9 @@ -/// \defgroup PkgSDGLinf L Infinity Segment Delaunay Graphs Reference +/// \defgroup PkgSDGLinfRef L Infinity Segment Delaunay Graphs Reference /// \defgroup PkgSDGLinfConcepts Concepts -/// \ingroup PkgSDGLinf +/// \ingroup PkgSDGLinfRef /*! -\addtogroup PkgSDGLinf +\addtogroup PkgSDGLinfRef \todo check generated documentation \cgalPkgDescriptionBegin{L Infinity Segment Delaunay Graphs,PkgSDGLinfSummary} @@ -14,7 +14,7 @@ \cgalPkgDesc{Algorithms and geometric traits for computing the dual of the Voronoi diagram of a set of points and segments under the \f$L_{\infty}\f$ metric.} -\cgalPkgManuals{Chapter_L_Infinity_Segment_Delaunay_Graphs,PkgSDGLinf} +\cgalPkgManuals{Chapter_L_Infinity_Segment_Delaunay_Graphs,PkgSDGLinfRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin diff --git a/Set_movable_separability_2/doc/Set_movable_separability_2/PackageDescription.txt b/Set_movable_separability_2/doc/Set_movable_separability_2/PackageDescription.txt index d67eb0b8c9d..e5c495945f6 100644 --- a/Set_movable_separability_2/doc/Set_movable_separability_2/PackageDescription.txt +++ b/Set_movable_separability_2/doc/Set_movable_separability_2/PackageDescription.txt @@ -1,18 +1,18 @@ -/// \defgroup PkgSetMovableSeparability2 2D Movable Separability of Sets Reference +/// \defgroup PkgSetMovableSeparability2Ref 2D Movable Separability of Sets Reference /// \defgroup top_edges_grp Top Edges /// These function determine whether a cavity (of a mold in the plane) /// that has the shape of a given polygon could be casted in the mold /// and then pulled out of the mold without colliding into the mold (but /// possibly sliding along the mold boundary). -/// \ingroup PkgSetMovableSeparability2 +/// \ingroup PkgSetMovableSeparability2Ref /// \defgroup is_pullout_direction_grp Is Pullout Direction /// These functions determine whether a cavity (of a mold in the plane) /// that has the shape of a given polygon could be casted in the mold /// and then pulled out of the mold in a given direction without colliding /// into the mold (but possibly sliding along the mold boundary). -/// \ingroup PkgSetMovableSeparability2 +/// \ingroup PkgSetMovableSeparability2Ref /// \defgroup pullout_directions_grp Pullout Directions /// These functions determine whether a cavity (of a mold in the plane) @@ -21,13 +21,13 @@ /// without colliding into the mold (but possibly sliding along the mold /// boundary). If the polygon is castable this way, the function /// computes the closed range of pullout directions. -/// \ingroup PkgSetMovableSeparability2 +/// \ingroup PkgSetMovableSeparability2Ref /// \defgroup PkgSetMovableSeparability2Concepts Concepts -/// \ingroup PkgSetMovableSeparability2 +/// \ingroup PkgSetMovableSeparability2Ref /*! -\addtogroup PkgSetMovableSeparability2 +\addtogroup PkgSetMovableSeparability2Ref \cgalPkgDescriptionBegin{2D Movable Separability of Sets,PkgSetMovableSeparability2Summary} \cgalPkgPicture{Casting_2.png} \cgalPkgSummaryBegin @@ -37,7 +37,7 @@ class of problems that deal with moving sets of objects, such as polygons in the plane; the challenge is to avoid collisions between the objects while considering different kinds of motions and various definitions of separation.} -\cgalPkgManuals{Chapter_SetMovableSeparability2,PkgSetMovableSeparability2} +\cgalPkgManuals{Chapter_SetMovableSeparability2,PkgSetMovableSeparability2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{4.12} diff --git a/Skin_surface_3/doc/Skin_surface_3/CGAL/Skin_surface_3.h b/Skin_surface_3/doc/Skin_surface_3/CGAL/Skin_surface_3.h index 43fe3738db0..2ff4d1a05ca 100644 --- a/Skin_surface_3/doc/Skin_surface_3/CGAL/Skin_surface_3.h +++ b/Skin_surface_3/doc/Skin_surface_3/CGAL/Skin_surface_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgSkinSurface3 +\ingroup PkgSkinSurface3Ref The `Skin_surface_3` is the main class in this package. It is a model of the concept `SkinSurface_3`. diff --git a/Skin_surface_3/doc/Skin_surface_3/CGAL/Skin_surface_polyhedral_items_3.h b/Skin_surface_3/doc/Skin_surface_3/CGAL/Skin_surface_polyhedral_items_3.h index 0a9442df293..e2e8e5584ae 100644 --- a/Skin_surface_3/doc/Skin_surface_3/CGAL/Skin_surface_polyhedral_items_3.h +++ b/Skin_surface_3/doc/Skin_surface_3/CGAL/Skin_surface_polyhedral_items_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgSkinSurface3 +\ingroup PkgSkinSurface3Ref An items class for the `Polyhedron_3` that stores information in faces instead of an auxiliary data structure. Using it accelerates the subdivision function `subdivide_skin_surface_mesh_3()`. */ diff --git a/Skin_surface_3/doc/Skin_surface_3/CGAL/Skin_surface_traits_3.h b/Skin_surface_3/doc/Skin_surface_3/CGAL/Skin_surface_traits_3.h index 9ab34f3c30a..eb1d74ac693 100644 --- a/Skin_surface_3/doc/Skin_surface_3/CGAL/Skin_surface_traits_3.h +++ b/Skin_surface_3/doc/Skin_surface_3/CGAL/Skin_surface_traits_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgSkinSurface3 +\ingroup PkgSkinSurface3Ref The class `Skin_surface_traits_3` is designed as a default traits class for the class `Skin_surface_3`. It is a model of diff --git a/Skin_surface_3/doc/Skin_surface_3/CGAL/Union_of_balls_3.h b/Skin_surface_3/doc/Skin_surface_3/CGAL/Union_of_balls_3.h index 04e523e559e..821e5910268 100644 --- a/Skin_surface_3/doc/Skin_surface_3/CGAL/Union_of_balls_3.h +++ b/Skin_surface_3/doc/Skin_surface_3/CGAL/Union_of_balls_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgSkinSurface3 +\ingroup PkgSkinSurface3Ref The `Union_of_balls_3` is used to represent a skin surface with shrink factor equal to one, which is the boundary of the union of the input diff --git a/Skin_surface_3/doc/Skin_surface_3/CGAL/make_skin_surface_mesh_3.h b/Skin_surface_3/doc/Skin_surface_3/CGAL/make_skin_surface_mesh_3.h index 2df94dec5fb..bc6093aab44 100644 --- a/Skin_surface_3/doc/Skin_surface_3/CGAL/make_skin_surface_mesh_3.h +++ b/Skin_surface_3/doc/Skin_surface_3/CGAL/make_skin_surface_mesh_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgSkinSurface3 +\ingroup PkgSkinSurface3Ref constructs a mesh of the skin surface defined by the weighted points and the shrink factor. diff --git a/Skin_surface_3/doc/Skin_surface_3/CGAL/mesh_skin_surface_3.h b/Skin_surface_3/doc/Skin_surface_3/CGAL/mesh_skin_surface_3.h index 8ab6fe9ca0b..c18efb9fb39 100644 --- a/Skin_surface_3/doc/Skin_surface_3/CGAL/mesh_skin_surface_3.h +++ b/Skin_surface_3/doc/Skin_surface_3/CGAL/mesh_skin_surface_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgSkinSurface3 +\ingroup PkgSkinSurface3Ref constructs a mesh of the `skin_surface` in `p`. diff --git a/Skin_surface_3/doc/Skin_surface_3/CGAL/subdivide_skin_surface_mesh_3.h b/Skin_surface_3/doc/Skin_surface_3/CGAL/subdivide_skin_surface_mesh_3.h index 85c3ef465fa..820aff81571 100644 --- a/Skin_surface_3/doc/Skin_surface_3/CGAL/subdivide_skin_surface_mesh_3.h +++ b/Skin_surface_3/doc/Skin_surface_3/CGAL/subdivide_skin_surface_mesh_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgSkinSurface3 +\ingroup PkgSkinSurface3Ref subdivides a skin surface mesh constructed diff --git a/Skin_surface_3/doc/Skin_surface_3/PackageDescription.txt b/Skin_surface_3/doc/Skin_surface_3/PackageDescription.txt index bb541cb99ae..911488ec95d 100644 --- a/Skin_surface_3/doc/Skin_surface_3/PackageDescription.txt +++ b/Skin_surface_3/doc/Skin_surface_3/PackageDescription.txt @@ -1,16 +1,16 @@ -/// \defgroup PkgSkinSurface3 3D Skin Surface Meshing Reference +/// \defgroup PkgSkinSurface3Ref 3D Skin Surface Meshing Reference /// \defgroup PkgSkinSurface3Concepts Concepts -/// \ingroup PkgSkinSurface3 +/// \ingroup PkgSkinSurface3Ref /*! -\addtogroup PkgSkinSurface3 +\addtogroup PkgSkinSurface3Ref \cgalPkgDescriptionBegin{3D Skin Surface Meshing,PkgSkinSurface3Summary} \cgalPkgPicture{small.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Nico Kruithof} \cgalPkgDesc{This package allows to build a triangular mesh of a skin surface. Skin surfaces are used for modeling large molecules in biological computing. The surface is defined by a set of balls, representing the atoms of the molecule, and a shrink factor that determines the size of the smooth patches gluing the balls together. The construction of a triangular mesh of a smooth skin surface is often necessary for further analysis and for fast visualization. This package provides functions to construct a triangular mesh approximating the skin surface from a set of balls and a shrink factor. It also contains code to subdivide the mesh efficiently. } -\cgalPkgManuals{Chapter_3D_Skin_Surface_Meshing,PkgSkinSurface3} +\cgalPkgManuals{Chapter_3D_Skin_Surface_Meshing,PkgSkinSurface3Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.3} diff --git a/Snap_rounding_2/doc/Snap_rounding_2/CGAL/Snap_rounding_2.h b/Snap_rounding_2/doc/Snap_rounding_2/CGAL/Snap_rounding_2.h index 4874ee272f8..e407669d24c 100644 --- a/Snap_rounding_2/doc/Snap_rounding_2/CGAL/Snap_rounding_2.h +++ b/Snap_rounding_2/doc/Snap_rounding_2/CGAL/Snap_rounding_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgSnapRounding2 +\ingroup PkgSnapRounding2Ref \f$ \def\A{{\cal A}} \f$ \f$ \def\S{{\cal S}} \f$ diff --git a/Snap_rounding_2/doc/Snap_rounding_2/CGAL/Snap_rounding_traits_2.h b/Snap_rounding_2/doc/Snap_rounding_2/CGAL/Snap_rounding_traits_2.h index bd3222545b8..8e0c352ef33 100644 --- a/Snap_rounding_2/doc/Snap_rounding_2/CGAL/Snap_rounding_traits_2.h +++ b/Snap_rounding_2/doc/Snap_rounding_2/CGAL/Snap_rounding_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgSnapRounding2 +\ingroup PkgSnapRounding2Ref The class `Snap_rounding_traits_2` is a model of the `SnapRoundingTraits_2` concept, and is the only traits class supplied diff --git a/Snap_rounding_2/doc/Snap_rounding_2/PackageDescription.txt b/Snap_rounding_2/doc/Snap_rounding_2/PackageDescription.txt index 908837d8052..ca292599232 100644 --- a/Snap_rounding_2/doc/Snap_rounding_2/PackageDescription.txt +++ b/Snap_rounding_2/doc/Snap_rounding_2/PackageDescription.txt @@ -1,15 +1,15 @@ -/// \defgroup PkgSnapRounding2 2D Snap Rounding Reference +/// \defgroup PkgSnapRounding2Ref 2D Snap Rounding Reference /// \defgroup PkgSnapRounding2Concepts Concepts -/// \ingroup PkgSnapRounding2 +/// \ingroup PkgSnapRounding2Ref /*! -\addtogroup PkgSnapRounding2 +\addtogroup PkgSnapRounding2Ref \todo check generated documentation \cgalPkgDescriptionBegin{2D Snap Rounding,PkgSnapRounding2Summary} \cgalPkgPicture{snap-detail.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Eli Packer} \cgalPkgDesc{Snap Rounding is a well known method for converting arbitrary-precision arrangements of segments into a fixed-precision representation. In the study of robust geometric computing, it can be classified as a finite precision approximation technique. Iterated Snap Rounding is a modification of Snap Rounding in which each vertex is at least half-the-width-of-a-pixel away from any non-incident edge. This package supports both methods.} -\cgalPkgManuals{Chapter_2D_Snap_Rounding,PkgSnapRounding2} +\cgalPkgManuals{Chapter_2D_Snap_Rounding,PkgSnapRounding2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.1} diff --git a/Solver_interface/doc/Solver_interface/PackageDescription.txt b/Solver_interface/doc/Solver_interface/PackageDescription.txt index c8cb3e86a2d..d9156f46a6e 100644 --- a/Solver_interface/doc/Solver_interface/PackageDescription.txt +++ b/Solver_interface/doc/Solver_interface/PackageDescription.txt @@ -1,17 +1,17 @@ -/// \defgroup PkgSolver CGAL and Solvers Reference +/// \defgroup PkgSolverRef CGAL and Solvers Reference /// \defgroup PkgSolverConcepts Concepts -/// \ingroup PkgSolver +/// \ingroup PkgSolverRef /// /*! -\addtogroup PkgSolver +\addtogroup PkgSolverRef \cgalPkgDescriptionBegin{CGAL and Solvers,PkgSolverSummary} \cgalPkgPicture{solver.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Simon Giraudot, Pierre Alliez, Frédéric Cazals, Gaël Guennebaud, Bruno Lévy, Marc Pouget, and Laurent Saboret} \cgalPkgDesc{This package provides concepts and models for solving linear systems with dense or sparse matrices.} -\cgalPkgManuals{Chapter_CGAL_and_Solvers,PkgSolver} +\cgalPkgManuals{Chapter_CGAL_and_Solvers,PkgSolverRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{4.8} diff --git a/Solver_interface/doc/Solver_interface/Solver_interface.txt b/Solver_interface/doc/Solver_interface/Solver_interface.txt index 8025bd5cafd..d035a80dba0 100644 --- a/Solver_interface/doc/Solver_interface/Solver_interface.txt +++ b/Solver_interface/doc/Solver_interface/Solver_interface.txt @@ -90,8 +90,8 @@ the solver: \section SolversHistory Implementation History This package is the result of the increasing needs for linear solvers in \cgal. The first packages that introduced the solver concepts were -\ref PkgSurfaceParameterization, \ref PkgPoissonSurfaceReconstruction -and \ref PkgJet_fitting_3. At that time, these packages were relying +\ref PkgSurfaceParameterizationRef, \ref PkgPoissonSurfaceReconstructionRef +and \ref PkgJet_fitting_3Ref. At that time, these packages were relying on \sc{Taucs}, \sc{LAPACK}, \sc{BLAS} and \sc{OpenNL}. Gaël Guennebaud then introduced new models using the \ref thirdpartyEigen library that became the only supported models by \cgal. Later on the packages \ref diff --git a/Solver_interface/include/CGAL/Default_diagonalize_traits.h b/Solver_interface/include/CGAL/Default_diagonalize_traits.h index 7dd97adf522..0389f49232b 100644 --- a/Solver_interface/include/CGAL/Default_diagonalize_traits.h +++ b/Solver_interface/include/CGAL/Default_diagonalize_traits.h @@ -30,7 +30,7 @@ namespace CGAL { -/// \ingroup PkgSolver +/// \ingroup PkgSolverRef /// /// The class `Default_diagonalize_traits` is a wrapper designed to automatically /// use `Eigen_diagonalize_traits` if Eigen is available and otherwise use diff --git a/Solver_interface/include/CGAL/Diagonalize_traits.h b/Solver_interface/include/CGAL/Diagonalize_traits.h index 57c086ef6b2..40b50a0bc1a 100644 --- a/Solver_interface/include/CGAL/Diagonalize_traits.h +++ b/Solver_interface/include/CGAL/Diagonalize_traits.h @@ -34,7 +34,7 @@ lead to precision issues, please use CGAL::Eigen_diagonalize_traits") namespace CGAL { -/// \ingroup PkgSolver +/// \ingroup PkgSolverRef /// /// The class `Diagonalize_traits` provides an internal /// implementation for the diagonalization of Variance-Covariance diff --git a/Solver_interface/include/CGAL/Eigen_diagonalize_traits.h b/Solver_interface/include/CGAL/Eigen_diagonalize_traits.h index 165a6ed56c0..1a0b15f742e 100644 --- a/Solver_interface/include/CGAL/Eigen_diagonalize_traits.h +++ b/Solver_interface/include/CGAL/Eigen_diagonalize_traits.h @@ -39,7 +39,7 @@ namespace CGAL { -/// \ingroup PkgSolver +/// \ingroup PkgSolverRef /// /// The class `Eigen_diagonalize_traits` provides an interface to the /// diagonalization of covariance matrices of \ref thirdpartyEigen diff --git a/Solver_interface/include/CGAL/Eigen_matrix.h b/Solver_interface/include/CGAL/Eigen_matrix.h index 9293f27c8a2..6e1f90f2975 100644 --- a/Solver_interface/include/CGAL/Eigen_matrix.h +++ b/Solver_interface/include/CGAL/Eigen_matrix.h @@ -27,7 +27,7 @@ namespace CGAL { /*! -\ingroup PkgSolver +\ingroup PkgSolverRef The class `Eigen_sparse_matrix` is a wrapper around \ref thirdpartyEigen "Eigen" matrix type `Eigen::SparseMatrix` @@ -265,7 +265,7 @@ private: }; // Eigen_sparse_matrix /*! -\ingroup PkgSolver +\ingroup PkgSolverRef The class `Eigen_sparse_symmetric_matrix` is a wrapper around \ref thirdpartyEigen "Eigen" matrix type `Eigen::SparseMatrix` @@ -301,7 +301,7 @@ struct Eigen_sparse_symmetric_matrix }; /*! -\ingroup PkgSolver +\ingroup PkgSolverRef The class `Eigen_matrix` is a wrapper around \ref thirdpartyEigen "Eigen" matrix type `Eigen::Matrix`. diff --git a/Solver_interface/include/CGAL/Eigen_solver_traits.h b/Solver_interface/include/CGAL/Eigen_solver_traits.h index d54e2f4a7d3..2f66eeb861c 100644 --- a/Solver_interface/include/CGAL/Eigen_solver_traits.h +++ b/Solver_interface/include/CGAL/Eigen_solver_traits.h @@ -71,7 +71,7 @@ struct Get_eigen_matrix< ::Eigen::SparseLU, FT> } //internal /*! -\ingroup PkgSolver +\ingroup PkgSolverRef The class `Eigen_solver_traits` provides an interface to the sparse solvers of \ref thirdpartyEigen "Eigen". \ref thirdpartyEigen "Eigen" version 3.1 (or later) must be available on the system. diff --git a/Solver_interface/include/CGAL/Eigen_svd.h b/Solver_interface/include/CGAL/Eigen_svd.h index a6db6704087..b39bead2be1 100644 --- a/Solver_interface/include/CGAL/Eigen_svd.h +++ b/Solver_interface/include/CGAL/Eigen_svd.h @@ -34,7 +34,7 @@ namespace CGAL { /*! -\ingroup PkgSolver +\ingroup PkgSolverRef The class `Eigen_svd` provides an algorithm to solve in the least square sense a linear system with a singular value decomposition using diff --git a/Solver_interface/include/CGAL/Eigen_vector.h b/Solver_interface/include/CGAL/Eigen_vector.h index 7e30d3fadd8..3e1a6a9509b 100644 --- a/Solver_interface/include/CGAL/Eigen_vector.h +++ b/Solver_interface/include/CGAL/Eigen_vector.h @@ -26,7 +26,7 @@ namespace CGAL { /*! -\ingroup PkgSolver +\ingroup PkgSolverRef The class `Eigen_vector` is a wrapper around \ref thirdpartyEigen "Eigen" vector type , diff --git a/Solver_interface/include/CGAL/Lapack_svd.h b/Solver_interface/include/CGAL/Lapack_svd.h index dea9a3147d4..a5ca3b75562 100644 --- a/Solver_interface/include/CGAL/Lapack_svd.h +++ b/Solver_interface/include/CGAL/Lapack_svd.h @@ -58,7 +58,7 @@ void dgelss(int *m, int *n, int *nrhs, namespace CGAL { -/// \ingroup PkgSolver +/// \ingroup PkgSolverRef /// /// A matrix class to be used in the class `Lapack_svd`. /// @@ -102,7 +102,7 @@ private: Lapack_vector& operator =(const Lapack_vector& toCopy); }; -/// \ingroup PkgSolver +/// \ingroup PkgSolverRef /// /// In CLAPACK, matrices are one-dimensional arrays and elements are /// column-major ordered. This class is a wrapper defining set and get @@ -152,7 +152,7 @@ private: Lapack_matrix& operator =(const Lapack_matrix& toCopy); }; -/// \ingroup PkgSolver +/// \ingroup PkgSolverRef /// /// This class is a wrapper to the singular value decomposition algorithm of LAPACK. /// diff --git a/Spatial_searching/doc/Spatial_searching/PackageDescription.txt b/Spatial_searching/doc/Spatial_searching/PackageDescription.txt index fb7d95df765..2b24bd24432 100644 --- a/Spatial_searching/doc/Spatial_searching/PackageDescription.txt +++ b/Spatial_searching/doc/Spatial_searching/PackageDescription.txt @@ -1,37 +1,37 @@ -/// \defgroup PkgSpatialSearchingD dD Spatial Searching Reference +/// \defgroup PkgSpatialSearchingDRef dD Spatial Searching Reference /// \defgroup PkgSpatialSearchingDConcepts Concepts -/// \ingroup PkgSpatialSearchingD +/// \ingroup PkgSpatialSearchingDRef /// \defgroup SearchClasses Search Classes -/// \ingroup PkgSpatialSearchingD +/// \ingroup PkgSpatialSearchingDRef /// \defgroup RangeQueryItemClasses Range Query Item Classes -/// \ingroup PkgSpatialSearchingD +/// \ingroup PkgSpatialSearchingDRef /// \defgroup SearchTraitsClasses Search Traits Classes -/// \ingroup PkgSpatialSearchingD +/// \ingroup PkgSpatialSearchingDRef /// \defgroup DistanceClasses Distance Classes -/// \ingroup PkgSpatialSearchingD +/// \ingroup PkgSpatialSearchingDRef /// \defgroup SplitterClasses Splitter Classes -/// \ingroup PkgSpatialSearchingD +/// \ingroup PkgSpatialSearchingDRef /// \defgroup AdvancedClasses Advanced Classes -/// \ingroup PkgSpatialSearchingD +/// \ingroup PkgSpatialSearchingDRef /*! -\addtogroup PkgSpatialSearchingD +\addtogroup PkgSpatialSearchingDRef \cgalPkgDescriptionBegin{dD Spatial Searching,PkgSpatialSearchingDSummary} \cgalPkgPicture{windowQuery.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Hans Tangelder and Andreas Fabri} \cgalPkgDesc{This package implements exact and approximate distance browsing by providing exact and approximate algorithms for range searching, k-nearest and k-furthest neighbor searching, as well as incremental nearest and incremental furthest neighbor searching, where the query items are points in dD Euclidean space.} -\cgalPkgManuals{Chapter_dD_Spatial_Searching,PkgSpatialSearchingD} +\cgalPkgManuals{Chapter_dD_Spatial_Searching,PkgSpatialSearchingDRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.0} diff --git a/Spatial_sorting/doc/Spatial_sorting/PackageDescription.txt b/Spatial_sorting/doc/Spatial_sorting/PackageDescription.txt index 08f97469814..1745cfc582c 100644 --- a/Spatial_sorting/doc/Spatial_sorting/PackageDescription.txt +++ b/Spatial_sorting/doc/Spatial_sorting/PackageDescription.txt @@ -1,29 +1,29 @@ -/// \defgroup PkgSpatialSorting Spatial Sorting Reference +/// \defgroup PkgSpatialSortingRef Spatial Sorting Reference /// \defgroup PkgSpatialSortingConcepts Concepts -/// \ingroup PkgSpatialSorting +/// \ingroup PkgSpatialSortingRef /// \defgroup PkgSpatialSortingTraits Traits Classes -/// \ingroup PkgSpatialSorting +/// \ingroup PkgSpatialSortingRef /// \defgroup PkgSpatialSortingUtils Utilities -/// \ingroup PkgSpatialSorting +/// \ingroup PkgSpatialSortingRef /// \defgroup PkgSpatialSortingFunctions Functions -/// \ingroup PkgSpatialSorting +/// \ingroup PkgSpatialSortingRef /// \defgroup PkgSpatialSortingFunctionObjects Function Objects -/// \ingroup PkgSpatialSorting +/// \ingroup PkgSpatialSortingRef /*! -\addtogroup PkgSpatialSorting +\addtogroup PkgSpatialSortingRef \cgalPkgDescriptionBegin{Spatial Sorting,PkgSpatialSortingSummary} \cgalPkgPicture{hilbert.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Christophe Delage and Olivier Devillers} \cgalPkgDesc{This package provides functions for sorting geometric objects in two, three and higher dimensions, including on a sphere, in order to improve efficiency of incremental geometric algorithms.} -\cgalPkgManuals{Chapter_Spatial_Sorting,PkgSpatialSorting} +\cgalPkgManuals{Chapter_Spatial_Sorting,PkgSpatialSortingRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.3} diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/PackageDescription.txt b/Straight_skeleton_2/doc/Straight_skeleton_2/PackageDescription.txt index 353a78069b5..28b00669641 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/PackageDescription.txt +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/PackageDescription.txt @@ -1,24 +1,24 @@ -/// \defgroup PkgStraightSkeleton2 2D Straight Skeleton and Polygon Offsetting Reference +/// \defgroup PkgStraightSkeleton2Ref 2D Straight Skeleton and Polygon Offsetting Reference /// \defgroup PkgStraightSkeleton2Concepts Concepts -/// \ingroup PkgStraightSkeleton2 +/// \ingroup PkgStraightSkeleton2Ref /// \defgroup PkgStraightSkeleton2Classes Classes -/// \ingroup PkgStraightSkeleton2 +/// \ingroup PkgStraightSkeleton2Ref /// \defgroup PkgStraightSkeleton2Auxiliary Auxiliary Classes -/// \ingroup PkgStraightSkeleton2 +/// \ingroup PkgStraightSkeleton2Ref /// \defgroup PkgStraightSkeleton2Functions Functions -/// \ingroup PkgStraightSkeleton2 +/// \ingroup PkgStraightSkeleton2Ref /*! -\addtogroup PkgStraightSkeleton2 +\addtogroup PkgStraightSkeleton2Ref \cgalPkgDescriptionBegin{2D Straight Skeleton and Polygon Offsetting,PkgStraightSkeleton2Summary} \cgalPkgPicture{Straight_skeleton_2/fig/StraightSkeletonTeaser.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Fernando Cacciola} \cgalPkgDesc{This package implements an algorithm to construct a halfedge data structure representing the straight skeleton in the interior of 2D polygons with holes and an algorithm to construct inward offset polygons at any offset distance given a straight skeleton.} -\cgalPkgManuals{Chapter_2D_Straight_Skeleton_and_Polygon_Offsetting,PkgStraightSkeleton2} +\cgalPkgManuals{Chapter_2D_Straight_Skeleton_and_Polygon_Offsetting,PkgStraightSkeleton2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.2} diff --git a/Stream_lines_2/doc/Stream_lines_2/CGAL/Euler_integrator_2.h b/Stream_lines_2/doc/Stream_lines_2/CGAL/Euler_integrator_2.h index 411ee87ee4f..cef2da98436 100644 --- a/Stream_lines_2/doc/Stream_lines_2/CGAL/Euler_integrator_2.h +++ b/Stream_lines_2/doc/Stream_lines_2/CGAL/Euler_integrator_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgPlacementOfStreamlines2 +\ingroup PkgPlacementOfStreamlines2Ref This class implements the first order Euler integrator. diff --git a/Stream_lines_2/doc/Stream_lines_2/CGAL/Regular_grid_2.h b/Stream_lines_2/doc/Stream_lines_2/CGAL/Regular_grid_2.h index 2fcd5696719..850553c9de8 100644 --- a/Stream_lines_2/doc/Stream_lines_2/CGAL/Regular_grid_2.h +++ b/Stream_lines_2/doc/Stream_lines_2/CGAL/Regular_grid_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgPlacementOfStreamlines2 +\ingroup PkgPlacementOfStreamlines2Ref This class provides a 2D vector field specified by a set of sample diff --git a/Stream_lines_2/doc/Stream_lines_2/CGAL/Runge_kutta_integrator_2.h b/Stream_lines_2/doc/Stream_lines_2/CGAL/Runge_kutta_integrator_2.h index 9e3e16c6e51..7fd71dc901e 100644 --- a/Stream_lines_2/doc/Stream_lines_2/CGAL/Runge_kutta_integrator_2.h +++ b/Stream_lines_2/doc/Stream_lines_2/CGAL/Runge_kutta_integrator_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgPlacementOfStreamlines2 +\ingroup PkgPlacementOfStreamlines2Ref This class implements the second order Runge-Kutta integrator. diff --git a/Stream_lines_2/doc/Stream_lines_2/CGAL/Stream_lines_2.h b/Stream_lines_2/doc/Stream_lines_2/CGAL/Stream_lines_2.h index d7de6332e56..4acf7d472be 100644 --- a/Stream_lines_2/doc/Stream_lines_2/CGAL/Stream_lines_2.h +++ b/Stream_lines_2/doc/Stream_lines_2/CGAL/Stream_lines_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgPlacementOfStreamlines2 +\ingroup PkgPlacementOfStreamlines2Ref The class `Stream_lines_2` generates a placement of streamlines in a 2D domain according to a bidimensional vector field. diff --git a/Stream_lines_2/doc/Stream_lines_2/CGAL/Triangular_field_2.h b/Stream_lines_2/doc/Stream_lines_2/CGAL/Triangular_field_2.h index eb04eff7d75..37f76d8f360 100644 --- a/Stream_lines_2/doc/Stream_lines_2/CGAL/Triangular_field_2.h +++ b/Stream_lines_2/doc/Stream_lines_2/CGAL/Triangular_field_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgPlacementOfStreamlines2 +\ingroup PkgPlacementOfStreamlines2Ref This class provides a vector field specified by a set of sample points diff --git a/Stream_lines_2/doc/Stream_lines_2/PackageDescription.txt b/Stream_lines_2/doc/Stream_lines_2/PackageDescription.txt index ce85d714f8b..17fe3667949 100644 --- a/Stream_lines_2/doc/Stream_lines_2/PackageDescription.txt +++ b/Stream_lines_2/doc/Stream_lines_2/PackageDescription.txt @@ -1,15 +1,15 @@ -/// \defgroup PkgPlacementOfStreamlines2 2D Placement of Streamlines Reference +/// \defgroup PkgPlacementOfStreamlines2Ref 2D Placement of Streamlines Reference /// \defgroup PkgPlacementOfStreamlines2Concepts Concepts -/// \ingroup PkgPlacementOfStreamlines2 +/// \ingroup PkgPlacementOfStreamlines2Ref /*! -\addtogroup PkgPlacementOfStreamlines2 +\addtogroup PkgPlacementOfStreamlines2Ref \cgalPkgDescriptionBegin{2D Placement of Streamlines,PkgPlacementOfStreamlines2Summary} \cgalPkgPicture{streamlines-small.jpg} \cgalPkgSummaryBegin \cgalPkgAuthor{Abdelkrim Mebarki} \cgalPkgDesc{Visualizing vector fields is important for many application domains. A good way to do it is to generate streamlines that describe the flow behavior. This package implements the "Farthest Point Seeding" algorithm for placing streamlines in 2D vector fields. It generates a list of streamlines corresponding to an input flow using a specified separating distance. The algorithm uses a Delaunay triangulation to model objects and address different queries, and relies on choosing the centers of the biggest empty circles to start the integration of the streamlines.} -\cgalPkgManuals{Chapter_2D_Placement_of_Streamlines,PkgPlacementOfStreamlines2} +\cgalPkgManuals{Chapter_2D_Placement_of_Streamlines,PkgPlacementOfStreamlines2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.2} diff --git a/Stream_support/doc/Stream_support/CGAL/IO/Color.h b/Stream_support/doc/Stream_support/CGAL/IO/Color.h index e3ad9813bdc..ebf2e7af76f 100644 --- a/Stream_support/doc/Stream_support/CGAL/IO/Color.h +++ b/Stream_support/doc/Stream_support/CGAL/IO/Color.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgIOstreams +\ingroup PkgIOstreamsRef An object of the class `Color` is a color available for drawing operations in many \cgal output streams. diff --git a/Stream_support/doc/Stream_support/CGAL/IO/Istream_iterator.h b/Stream_support/doc/Stream_support/CGAL/IO/Istream_iterator.h index cb90ef6695b..9a86afd5fea 100644 --- a/Stream_support/doc/Stream_support/CGAL/IO/Istream_iterator.h +++ b/Stream_support/doc/Stream_support/CGAL/IO/Istream_iterator.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgIOstreams +\ingroup PkgIOstreamsRef The class `Istream_iterator` is an input iterator adaptor for the input stream class `Stream` and value type `T`. It is particularly diff --git a/Stream_support/doc/Stream_support/CGAL/IO/Ostream_iterator.h b/Stream_support/doc/Stream_support/CGAL/IO/Ostream_iterator.h index 71ea3de2419..4c2dde591da 100644 --- a/Stream_support/doc/Stream_support/CGAL/IO/Ostream_iterator.h +++ b/Stream_support/doc/Stream_support/CGAL/IO/Ostream_iterator.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgIOstreams +\ingroup PkgIOstreamsRef The class `Ostream_iterator` is an output iterator adaptor for the output stream class `Stream` and value type `T`. diff --git a/Stream_support/doc/Stream_support/CGAL/IO/Verbose_ostream.h b/Stream_support/doc/Stream_support/CGAL/IO/Verbose_ostream.h index 60195fc183d..de3be14eccc 100644 --- a/Stream_support/doc/Stream_support/CGAL/IO/Verbose_ostream.h +++ b/Stream_support/doc/Stream_support/CGAL/IO/Verbose_ostream.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgIOstreams +\ingroup PkgIOstreamsRef The class `Verbose_ostream` can be used as an output stream. The stream output operator `<<` is defined for any type. The class diff --git a/Stream_support/doc/Stream_support/CGAL/IO/io.h b/Stream_support/doc/Stream_support/CGAL/IO/io.h index 549aeea9d8b..7870bedd001 100644 --- a/Stream_support/doc/Stream_support/CGAL/IO/io.h +++ b/Stream_support/doc/Stream_support/CGAL/IO/io.h @@ -3,7 +3,7 @@ namespace CGAL { namespace IO{ /*! - \ingroup PkgIOstreams + \ingroup PkgIOstreamsRef All classes in the \cgal `Kernel` provide input and output operators for IOStreams. The basic task of such an operator is to produce a @@ -38,7 +38,7 @@ enum Mode { ASCII = 0, BINARY, PRETTY }; } /*! -\ingroup PkgIOstreams +\ingroup PkgIOstreamsRef returns the printing mode of the %IO stream `s`. @@ -56,7 +56,7 @@ returns the printing mode of the %IO stream `s`. IO::Mode get_mode(std::ios& s); /*! -\ingroup PkgIOstreams +\ingroup PkgIOstreamsRef sets the mode of the %IO stream `s` to be the `IO::ASCII` mode. Returns the previous mode of `s`. @@ -74,7 +74,7 @@ Returns the previous mode of `s`. IO::Mode set_ascii_mode(std::ios& s); /*! -\ingroup PkgIOstreams +\ingroup PkgIOstreamsRef \sa `CGAL::IO::Mode` \sa `CGAL::set_mode()` @@ -91,7 +91,7 @@ Returns the previous mode of `s`. IO::Mode set_binary_mode(std::ios& s); /*! -\ingroup PkgIOstreams +\ingroup PkgIOstreamsRef sets the printing mode of the %IO stream `s`. @@ -107,7 +107,7 @@ sets the printing mode of the %IO stream `s`. IO::Mode set_mode(std::ios& s, IO::Mode m); /*! -\ingroup PkgIOstreams +\ingroup PkgIOstreamsRef sets the mode of the %IO stream `s` to be the `IO::PRETTY` mode. Returns the previous mode of `s`. @@ -126,7 +126,7 @@ IO::Mode set_pretty_mode(std::ios& s); /*! -\ingroup PkgIOstreams +\ingroup PkgIOstreamsRef The definition of `Input_rep` is completely symmetric to `Output_rep`. @@ -137,7 +137,7 @@ class Input_rep { }; /* end Input_rep */ /*! -\ingroup PkgIOstreams +\ingroup PkgIOstreamsRef The purpose of `Output_rep` is to provide a way to control output formatting that works independently of the object's stream output operator. @@ -171,7 +171,7 @@ class Output_rep { /*! -\ingroup PkgIOstreams +\ingroup PkgIOstreamsRef checks if the %IO stream `s` is in `IO::ASCII` mode. @@ -188,7 +188,7 @@ bool is_ascii(std::ios& s); /*! -\ingroup PkgIOstreams +\ingroup PkgIOstreamsRef checks if the %IO stream `s` is in `IO::BINARY` mode. @@ -204,7 +204,7 @@ checks if the %IO stream `s` is in `IO::BINARY` mode. bool is_binary(std::ios& s); /*! -\ingroup PkgIOstreams +\ingroup PkgIOstreamsRef checks if the %IO stream `s` is in `IO::PRETTY` mode. @@ -221,7 +221,7 @@ checks if the %IO stream `s` is in `IO::PRETTY` mode. bool is_pretty(std::ios& s); /*! -\ingroup PkgIOstreams +\ingroup PkgIOstreamsRef Convenience function to construct an output representation (`Output_rep`) for type `T`. @@ -230,7 +230,7 @@ Generic IO for type `T`. template Output_rep oformat( const T& t); /*! -\ingroup PkgIOstreams +\ingroup PkgIOstreamsRef The definition of this function is completely symmetric to `oformat()`. */ @@ -238,7 +238,7 @@ template Input_rep iformat( const T& t); /*! -\ingroup PkgIOstreams +\ingroup PkgIOstreamsRef Convenience function to construct an output representation (`Output_rep`) for type `T`. diff --git a/Stream_support/doc/Stream_support/PackageDescription.txt b/Stream_support/doc/Stream_support/PackageDescription.txt index 07cf8dcf7ad..0ecad560998 100644 --- a/Stream_support/doc/Stream_support/PackageDescription.txt +++ b/Stream_support/doc/Stream_support/PackageDescription.txt @@ -1,14 +1,14 @@ -/// \defgroup PkgIOstreams IO Streams Reference +/// \defgroup PkgIOstreamsRef IO Streams Reference /// \defgroup IOstreamOperators Stream Operators -/// \ingroup PkgIOstreams +/// \ingroup PkgIOstreamsRef /*! -\addtogroup PkgIOstreams +\addtogroup PkgIOstreamsRef \cgalPkgDescriptionBegin{IO Streams,PkgIOstreamsSummary} \cgalPkgPicture{io.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Andreas Fabri, Geert-Jan Giezeman, and Lutz Kettner} \cgalPkgDesc{All classes in the \cgal kernel provide input and output operators for IO streams. The basic task of such an operator is to produce a representation of an object that can be written as a sequence of characters on devices as a console, a file, or a pipe. In \cgal we distinguish between a raw ascii, a raw binary and a pretty printing format.} -\cgalPkgManuals{Chapter_IO_Streams,PkgIOstreams} +\cgalPkgManuals{Chapter_IO_Streams,PkgIOstreamsRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{1.0} diff --git a/Subdivision_method_3/doc/Subdivision_method_3/NamedParameters.txt b/Subdivision_method_3/doc/Subdivision_method_3/NamedParameters.txt index 25ccd8f1e11..4accfce3524 100644 --- a/Subdivision_method_3/doc/Subdivision_method_3/NamedParameters.txt +++ b/Subdivision_method_3/doc/Subdivision_method_3/NamedParameters.txt @@ -1,6 +1,6 @@ /*! \defgroup sm_namedparameters Named Parameters for Subdivision Methods -\ingroup PkgSurfaceSubdivisionMethods3 +\ingroup PkgSurfaceSubdivisionMethods3Ref In this package, all functions optional parameters are implemented as BGL optional named parameters (see \ref BGLNamedParameters for more information on how to use them). diff --git a/Subdivision_method_3/doc/Subdivision_method_3/PackageDescription.txt b/Subdivision_method_3/doc/Subdivision_method_3/PackageDescription.txt index 810657c81e5..8236ca110b6 100644 --- a/Subdivision_method_3/doc/Subdivision_method_3/PackageDescription.txt +++ b/Subdivision_method_3/doc/Subdivision_method_3/PackageDescription.txt @@ -1,20 +1,20 @@ -/// \defgroup PkgSurfaceSubdivisionMethods3 3D Surface Subdivision Methods +/// \defgroup PkgSurfaceSubdivisionMethods3Ref 3D Surface Subdivision Methods /// \defgroup PkgSurfaceSubdivisionMethods3Concepts Concepts -/// \ingroup PkgSurfaceSubdivisionMethods3 +/// \ingroup PkgSurfaceSubdivisionMethods3Ref /// \defgroup PkgSurfaceSubdivisionMethods3Functions Subdivision Methods -/// \ingroup PkgSurfaceSubdivisionMethods3 +/// \ingroup PkgSurfaceSubdivisionMethods3Ref /*! -\addtogroup PkgSurfaceSubdivisionMethods3 +\addtogroup PkgSurfaceSubdivisionMethods3Ref \cgalPkgDescriptionBegin{3D Surface Subdivision Methods,PkgSurfaceSubdivisionMethods3Summary} \cgalPkgPicture{twoheads-detail.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Le-Jeng Andy Shiue} \cgalPkgDesc{Subdivision methods recursively refine a control mesh and generate points approximating the limit surface. This package consists of four popular subdivision methods and their refinement hosts. Supported subdivision methods include Catmull-Clark, Loop, Doo-Sabin and \f$ \sqrt{3}\f$ subdivisions. Their respective refinement hosts are Pqq, Ptq, Dqq and \f$ \sqrt{3}\f$ refinements. Variations of those methods can be easily extended by substituting the geometry computation of the refinement host.} -\cgalPkgManuals{Chapter_3D_Surface_Subdivision_Methods,PkgSurfaceSubdivisionMethods3} +\cgalPkgManuals{Chapter_3D_Surface_Subdivision_Methods,PkgSurfaceSubdivisionMethods3Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{4.11} diff --git a/Subdivision_method_3/include/CGAL/Subdivision_method_3/subdivision_masks_3.h b/Subdivision_method_3/include/CGAL/Subdivision_method_3/subdivision_masks_3.h index e6353e38b61..c36477b4783 100644 --- a/Subdivision_method_3/include/CGAL/Subdivision_method_3/subdivision_masks_3.h +++ b/Subdivision_method_3/include/CGAL/Subdivision_method_3/subdivision_masks_3.h @@ -136,7 +136,7 @@ public: // ====================================================================== /*! -\ingroup PkgSurfaceSubdivisionMethods3 +\ingroup PkgSurfaceSubdivisionMethods3Ref The geometry mask of Catmull-Clark subdivision. @@ -260,7 +260,7 @@ public: // ====================================================================== /*! -\ingroup PkgSurfaceSubdivisionMethods3 +\ingroup PkgSurfaceSubdivisionMethods3Ref The geometry mask of Loop subdivision. @@ -422,7 +422,7 @@ public: // ====================================================================== /*! -\ingroup PkgSurfaceSubdivisionMethods3 +\ingroup PkgSurfaceSubdivisionMethods3Ref The geometry mask of Doo-Sabin subdivision. @@ -517,7 +517,7 @@ public: // ====================================================================== /*! -\ingroup PkgSurfaceSubdivisionMethods3 +\ingroup PkgSurfaceSubdivisionMethods3Ref The geometry mask of Sqrt(3) subdivision. diff --git a/Subdivision_method_3/include/CGAL/subdivision_method_3.h b/Subdivision_method_3/include/CGAL/subdivision_method_3.h index 15e6ee141e7..95f9067de7b 100644 --- a/Subdivision_method_3/include/CGAL/subdivision_method_3.h +++ b/Subdivision_method_3/include/CGAL/subdivision_method_3.h @@ -23,7 +23,7 @@ // ====================================================================== /** -* \ingroup PkgSurfaceSubdivisionMethods3 +* \ingroup PkgSurfaceSubdivisionMethods3Ref * \file CGAL/subdivision_method_3.h * Convenience header file including the headers for all * the free functions of this package. diff --git a/Surface_mesh_deformation/doc/Surface_mesh_deformation/PackageDescription.txt b/Surface_mesh_deformation/doc/Surface_mesh_deformation/PackageDescription.txt index 9e6d03b2ed2..8420fdd49d4 100644 --- a/Surface_mesh_deformation/doc/Surface_mesh_deformation/PackageDescription.txt +++ b/Surface_mesh_deformation/doc/Surface_mesh_deformation/PackageDescription.txt @@ -1,16 +1,16 @@ -/// \defgroup PkgSurfaceMeshDeformation Triangulated Surface Mesh Deformation Reference +/// \defgroup PkgSurfaceMeshDeformationRef Triangulated Surface Mesh Deformation Reference /// \defgroup PkgSurfaceMeshDeformationConcepts Concepts -/// \ingroup PkgSurfaceMeshDeformation +/// \ingroup PkgSurfaceMeshDeformationRef /*! -\addtogroup PkgSurfaceMeshDeformation +\addtogroup PkgSurfaceMeshDeformationRef \cgalPkgDescriptionBegin{Triangulated Surface Mesh Deformation,PkgSurfaceMeshDeformationSummary} \cgalPkgPicture{deform-ico.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Sébastien Loriot, Olga Sorkine-Hornung, Yin Xu and Ilker %O. Yaz} \cgalPkgDesc{This package offers surface mesh deformation algorithms which provide new positions to the vertices of a surface mesh under positional constraints of some of its vertices, without requiring any additional structure other than the surface mesh itself.} -\cgalPkgManuals{Chapter_SurfaceMeshDeformation,PkgSurfaceMeshDeformation} +\cgalPkgManuals{Chapter_SurfaceMeshDeformation,PkgSurfaceMeshDeformationRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{4.5} diff --git a/Surface_mesh_deformation/include/CGAL/Deformation_Eigen_closest_rotation_traits_3.h b/Surface_mesh_deformation/include/CGAL/Deformation_Eigen_closest_rotation_traits_3.h index 1350947abdf..30fa0065b7e 100644 --- a/Surface_mesh_deformation/include/CGAL/Deformation_Eigen_closest_rotation_traits_3.h +++ b/Surface_mesh_deformation/include/CGAL/Deformation_Eigen_closest_rotation_traits_3.h @@ -26,7 +26,7 @@ #include namespace CGAL { -/// \ingroup PkgSurfaceMeshDeformation +/// \ingroup PkgSurfaceMeshDeformationRef /// A class to compute the closest rotation in Frobenius norm to a 3x3 Matrix using the \link thirdpartyEigen `Eigen` library \endlink. /// The internal computation relies on `Eigen::JacobiSVD<>` solver. /// diff --git a/Surface_mesh_deformation/include/CGAL/Deformation_Eigen_polar_closest_rotation_traits_3.h b/Surface_mesh_deformation/include/CGAL/Deformation_Eigen_polar_closest_rotation_traits_3.h index 24e12cb0de2..b481ee01ece 100644 --- a/Surface_mesh_deformation/include/CGAL/Deformation_Eigen_polar_closest_rotation_traits_3.h +++ b/Surface_mesh_deformation/include/CGAL/Deformation_Eigen_polar_closest_rotation_traits_3.h @@ -27,7 +27,7 @@ #include namespace CGAL { - /// \ingroup PkgSurfaceMeshDeformation + /// \ingroup PkgSurfaceMeshDeformationRef /// A class to compute the closest rotation in Frobenius norm to a 3x3 Matrix using the \link thirdpartyEigen `Eigen` library \endlink. /// The internal computation relies on a hybrid system using the solvers `Eigen::SelfAdjointEigenSolver<>` /// and `Eigen::JacobiSVD<>` (polar decomposition). diff --git a/Surface_mesh_deformation/include/CGAL/Surface_mesh_deformation.h b/Surface_mesh_deformation/include/CGAL/Surface_mesh_deformation.h index c9d2b7576f0..f25f6f43a9d 100644 --- a/Surface_mesh_deformation/include/CGAL/Surface_mesh_deformation.h +++ b/Surface_mesh_deformation/include/CGAL/Surface_mesh_deformation.h @@ -52,7 +52,7 @@ namespace CGAL { -/// \ingroup PkgSurfaceMeshDeformation +/// \ingroup PkgSurfaceMeshDeformationRef ///@brief Deformation algorithm type enum Deformation_algorithm_tag { @@ -173,7 +173,7 @@ struct SC_on_the_fly_pmap: public Vertex_point_map{ /// @endcond /// - /// \ingroup PkgSurfaceMeshDeformation + /// \ingroup PkgSurfaceMeshDeformationRef /// @brief Class providing the functionalities for deforming a triangulated surface mesh /// /// @tparam TM a model of `HalfedgeGraph` diff --git a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/PackageDescription.txt b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/PackageDescription.txt index 834d640d929..03cb39c4d31 100644 --- a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/PackageDescription.txt +++ b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/PackageDescription.txt @@ -1,8 +1,8 @@ -/// \defgroup PkgSurfaceParameterization Triangulated Surface Mesh Parameterization Reference +/// \defgroup PkgSurfaceParameterizationRef Triangulated Surface Mesh Parameterization Reference /*! -\addtogroup PkgSurfaceParameterization +\addtogroup PkgSurfaceParameterizationRef \cgalPkgDescriptionBegin{Triangulated Surface Mesh Parameterization,PkgSurfaceParameterizationSummary} \cgalPkgPicture{bimbaDetail.png} \cgalPkgSummaryBegin @@ -15,7 +15,7 @@ As Rigid As Possible Parameterization, Discrete Authalic Parameterization, Discrete Conformal Map, Floater Mean Value Coordinates, Least Squares Conformal Maps, Orbifold Tutte Embedding, or Tutte Barycentric Mapping. The code is generic and works with any model of the `FaceGraph` concept.} -\cgalPkgManuals{Chapter_Planar_Parameterization_of_Triangulated_Surface_Meshes, PkgSurfaceParameterization} +\cgalPkgManuals{Chapter_Planar_Parameterization_of_Triangulated_Surface_Meshes, PkgSurfaceParameterizationRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.2} @@ -114,28 +114,28 @@ The package performs the next checks: /*! \defgroup PkgSurfaceParameterizationMainFunction Main Functions - \ingroup PkgSurfaceParameterization + \ingroup PkgSurfaceParameterizationRef The central functions, main entry point of the package. */ /*! \defgroup PkgSurfaceParameterizationEnums Enums - \ingroup PkgSurfaceParameterization + \ingroup PkgSurfaceParameterizationRef The enum classes defined and used in this package. */ /*! \defgroup PkgSurfaceParameterizationConcepts Concepts - \ingroup PkgSurfaceParameterization + \ingroup PkgSurfaceParameterizationRef The concepts of this package. */ /*! \defgroup PkgSurfaceParameterizationMethods Surface Parameterization Methods - \ingroup PkgSurfaceParameterization + \ingroup PkgSurfaceParameterizationRef This \cgal package implements several parameterization methods: @@ -157,7 +157,7 @@ The package performs the next checks: /*! \defgroup PkgSurfaceParameterizationBorderParameterizationMethods Border Parameterization Methods - \ingroup PkgSurfaceParameterization + \ingroup PkgSurfaceParameterizationRef Border parameterization methods define a set of constraints (a constraint specifies two (u,v) coordinates for diff --git a/Surface_mesh_segmentation/doc/Surface_mesh_segmentation/PackageDescription.txt b/Surface_mesh_segmentation/doc/Surface_mesh_segmentation/PackageDescription.txt index 43c56dfdf1e..f311d083dfe 100644 --- a/Surface_mesh_segmentation/doc/Surface_mesh_segmentation/PackageDescription.txt +++ b/Surface_mesh_segmentation/doc/Surface_mesh_segmentation/PackageDescription.txt @@ -1,11 +1,11 @@ -/// \defgroup PkgSurfaceSegmentation Triangulated Surface Mesh Segmentation Reference +/// \defgroup PkgSurfaceSegmentationRef Triangulated Surface Mesh Segmentation Reference /// \defgroup PkgSurfaceSegmentationConcepts Concepts -/// \ingroup PkgSurfaceSegmentation +/// \ingroup PkgSurfaceSegmentationRef /*! -\addtogroup PkgSurfaceSegmentation +\addtogroup PkgSurfaceSegmentationRef \cgalPkgDescriptionBegin{Triangulated Surface Mesh Segmentation,PkgSurfaceSegmentationSummary} \cgalPkgPicture{segmentation_ico.png} @@ -17,7 +17,7 @@ Shape Diameter Function (SDF) for all facets and applies a graph-cut based algorithm over these values. Low level functions are provided to replace any intermediate step by a custom one. } -\cgalPkgManuals{Chapter_3D_SurfaceSegmentation,PkgSurfaceSegmentation} +\cgalPkgManuals{Chapter_3D_SurfaceSegmentation,PkgSurfaceSegmentationRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin diff --git a/Surface_mesh_segmentation/include/CGAL/mesh_segmentation.h b/Surface_mesh_segmentation/include/CGAL/mesh_segmentation.h index 49da4622a96..db33df616a8 100644 --- a/Surface_mesh_segmentation/include/CGAL/mesh_segmentation.h +++ b/Surface_mesh_segmentation/include/CGAL/mesh_segmentation.h @@ -69,7 +69,7 @@ sdf_values( const TriangleMesh& triangle_mesh, /// @endcond /*! - * \ingroup PkgSurfaceSegmentation + * \ingroup PkgSurfaceSegmentationRef * @brief Function computing the Shape Diameter Function over a surface mesh. * * This function implements the Shape Diameter Function (SDF) as described in \cgalCite{shapira2008consistent}. @@ -117,7 +117,7 @@ sdf_values( const TriangleMesh& triangle_mesh, /*! - * \ingroup PkgSurfaceSegmentation + * \ingroup PkgSurfaceSegmentationRef * @brief Function post-processing raw SDF values computed per facet. * * Post-processing steps applied : @@ -152,7 +152,7 @@ sdf_values_postprocessing(const TriangleMesh& triangle_mesh, /*! - * \ingroup PkgSurfaceSegmentation + * \ingroup PkgSurfaceSegmentationRef * @brief Function computing the segmentation of a surface mesh given an SDF value per facet. * * This function fills a property map which associates a segment-id (in [0, number of segments -1]) @@ -252,7 +252,7 @@ segmentation_via_sdf_values(const TriangleMesh& triangle_mesh, /*! - * \ingroup PkgSurfaceSegmentation + * \ingroup PkgSurfaceSegmentationRef * @brief Function computing the segmentation of a surface mesh. * * This function is equivalent to calling the functions `CGAL::sdf_values()` and diff --git a/Surface_mesh_shortest_path/doc/Surface_mesh_shortest_path/PackageDescription.txt b/Surface_mesh_shortest_path/doc/Surface_mesh_shortest_path/PackageDescription.txt index 92612538034..ecb84fd86d1 100644 --- a/Surface_mesh_shortest_path/doc/Surface_mesh_shortest_path/PackageDescription.txt +++ b/Surface_mesh_shortest_path/doc/Surface_mesh_shortest_path/PackageDescription.txt @@ -1,15 +1,15 @@ // Triangulated Surface Mesh Geodesic Shortest Paths -/// \defgroup PkgSurfaceMeshShortestPath Triangulated Surface Mesh Geodesic Shortest Paths Reference +/// \defgroup PkgSurfaceMeshShortestPathRef Triangulated Surface Mesh Geodesic Shortest Paths Reference /// \defgroup PkgSurfaceMeshShortestPathConcepts Concepts -/// \ingroup PkgSurfaceMeshShortestPath +/// \ingroup PkgSurfaceMeshShortestPathRef /// \defgroup PkgSurfaceMeshShortestPathTraitsClasses Traits Classes -/// \ingroup PkgSurfaceMeshShortestPath +/// \ingroup PkgSurfaceMeshShortestPathRef /*! -\addtogroup PkgSurfaceMeshShortestPath +\addtogroup PkgSurfaceMeshShortestPathRef \todo Modify the algorithm to support more efficient incremental construction \todo Add parallelization to the algorithm \todo Add methods for computing the ridge tree using the output of the algorithm @@ -20,7 +20,7 @@ \cgalPkgSummaryBegin \cgalPkgAuthors{Stephen Kiazyk, Sébastien Loriot, Éric Colin de Verdière} \cgalPkgDesc{The package provides methods for computing geodesic shortest path on triangulated surface meshes. The algorithm used is based on a paper by Xin and Wang \cgalCite{XinWang2009improvingchenandhan} . The input of this package can be any model of the `FaceListGraph` concept. } -\cgalPkgManuals{Chapter_Surface_mesh_shortest_path,PkgSurfaceMeshShortestPath} +\cgalPkgManuals{Chapter_Surface_mesh_shortest_path,PkgSurfaceMeshShortestPathRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{4.7} diff --git a/Surface_mesh_shortest_path/include/CGAL/Surface_mesh_shortest_path.h b/Surface_mesh_shortest_path/include/CGAL/Surface_mesh_shortest_path.h index e196e2e63ac..2f9d75f00fd 100644 --- a/Surface_mesh_shortest_path/include/CGAL/Surface_mesh_shortest_path.h +++ b/Surface_mesh_shortest_path/include/CGAL/Surface_mesh_shortest_path.h @@ -25,7 +25,7 @@ /** - * \ingroup PkgSurfaceMeshShortestPath + * \ingroup PkgSurfaceMeshShortestPathRef * \file CGAL/Surface_mesh_shortest_path.h * Convenience header file only including `CGAL/Surface_mesh_shortest_path/Surface_mesh_shortest_path.h` * and `CGAL/Surface_mesh_shortest_path/Surface_mesh_shortest_path_traits.h`. diff --git a/Surface_mesh_shortest_path/include/CGAL/Surface_mesh_shortest_path/Surface_mesh_shortest_path.h b/Surface_mesh_shortest_path/include/CGAL/Surface_mesh_shortest_path/Surface_mesh_shortest_path.h index 68bd9b9327c..15170a91326 100644 --- a/Surface_mesh_shortest_path/include/CGAL/Surface_mesh_shortest_path/Surface_mesh_shortest_path.h +++ b/Surface_mesh_shortest_path/include/CGAL/Surface_mesh_shortest_path/Surface_mesh_shortest_path.h @@ -54,7 +54,7 @@ namespace CGAL { /*! -\ingroup PkgSurfaceMeshShortestPath +\ingroup PkgSurfaceMeshShortestPathRef \brief Computes shortest surface paths from one or more source points on a surface mesh. diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Edge_collapse_visitor_base.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Edge_collapse_visitor_base.h index 4fb784a6762..6f3f8b45fcc 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Edge_collapse_visitor_base.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Edge_collapse_visitor_base.h @@ -2,7 +2,7 @@ namespace CGAL { namespace Surface_mesh_simplification { /*! -\ingroup PkgSurfaceMeshSimplification +\ingroup PkgSurfaceMeshSimplificationRef The class `Surface_mesh_simplification::Edge_collapse_visitor_base` provides a base class for models of the `EdgeCollapseSimplificationVisitor` concept. diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Bounded_normal_change_placement.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Bounded_normal_change_placement.h index d8db52c58d5..3fabd75ee17 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Bounded_normal_change_placement.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Bounded_normal_change_placement.h @@ -3,7 +3,7 @@ namespace CGAL { namespace Surface_mesh_simplification { /*! -\ingroup PkgSurfaceMeshSimplification +\ingroup PkgSurfaceMeshSimplificationRef The class `Bounded_normal_change_placement` is a model for the `GetPlacement` concept which serves as a filter for another placement. It rejects the placement if any diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Constrained_placement.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Constrained_placement.h index 6dbd277a059..94e5c193e39 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Constrained_placement.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Constrained_placement.h @@ -3,7 +3,7 @@ namespace CGAL { namespace Surface_mesh_simplification { /*! -\ingroup PkgSurfaceMeshSimplification +\ingroup PkgSurfaceMeshSimplificationRef The class `Constrained_placement` is a model for the `GetPlacement` concept provided the template parameter `BasePlacement` is such a model. diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_ratio_stop_predicate.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_ratio_stop_predicate.h index 726294904e6..0d01d7b04a7 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_ratio_stop_predicate.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_ratio_stop_predicate.h @@ -3,7 +3,7 @@ namespace CGAL { namespace Surface_mesh_simplification { /*! -\ingroup PkgSurfaceMeshSimplification +\ingroup PkgSurfaceMeshSimplificationRef The class `Count_ratio_stop_predicate` is a model for the `StopPredicate` concept which returns `true` when the relation between the initial and current number of edges drops below a certain ratio. diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_stop_predicate.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_stop_predicate.h index a7f5861cbea..7e11c1950ad 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_stop_predicate.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_stop_predicate.h @@ -3,7 +3,7 @@ namespace CGAL { namespace Surface_mesh_simplification { /*! -\ingroup PkgSurfaceMeshSimplification +\ingroup PkgSurfaceMeshSimplificationRef The class `Count_stop_predicate` is a model for the `StopPredicate` concept, which returns `true` when the number of current edges drops below a certain threshold. diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_length_cost.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_length_cost.h index 8d6f35ace4d..58f43d54057 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_length_cost.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_length_cost.h @@ -3,7 +3,7 @@ namespace CGAL { namespace Surface_mesh_simplification { /*! -\ingroup PkgSurfaceMeshSimplification +\ingroup PkgSurfaceMeshSimplificationRef The class `Edge_length_cost` is a model for the `GetCost` concept, which computes the collapse cost as the squared length of the edge. diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_length_stop_predicate.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_length_stop_predicate.h index 1363c60da46..d2c11fec0be 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_length_stop_predicate.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_length_stop_predicate.h @@ -3,7 +3,7 @@ namespace CGAL { namespace Surface_mesh_simplification { /*! -\ingroup PkgSurfaceMeshSimplification +\ingroup PkgSurfaceMeshSimplificationRef The class `Edge_length_stop_predicate` is a model for the `StopPredicate` concept, which returns `true` when the top edge in the priority queue is larger than a certain threshold. diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_profile.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_profile.h index dc0bf118dd2..77fd121f6f7 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_profile.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_profile.h @@ -3,7 +3,7 @@ namespace CGAL { namespace Surface_mesh_simplification { /*! -\ingroup PkgSurfaceMeshSimplification +\ingroup PkgSurfaceMeshSimplificationRef The class `Edge_profile` provides a model for the `EdgeProfile` concept. diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_cost.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_cost.h index c4a5e75a712..8a5a91dd3ac 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_cost.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_cost.h @@ -2,7 +2,7 @@ namespace CGAL { namespace Surface_mesh_simplification { /*! -\ingroup PkgSurfaceMeshSimplification +\ingroup PkgSurfaceMeshSimplificationRef The class `LindstromTurk_cost` provides a model for the `GetCost` concept. It computes the collapse cost following the Lindstrom-Turk strategy diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_placement.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_placement.h index 431de0560dd..b182d0f246b 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_placement.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_placement.h @@ -3,7 +3,7 @@ namespace CGAL { namespace Surface_mesh_simplification { /*! -\ingroup PkgSurfaceMeshSimplification +\ingroup PkgSurfaceMeshSimplificationRef The class `LindstromTurk_placement` provides a model for the `GetPlacement` concept. It computes the placement, that is, the new position for the remaining vertex after diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Midpoint_placement.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Midpoint_placement.h index 76f0e524b04..feef0b812da 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Midpoint_placement.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Midpoint_placement.h @@ -3,7 +3,7 @@ namespace CGAL { namespace Surface_mesh_simplification { /*! -\ingroup PkgSurfaceMeshSimplification +\ingroup PkgSurfaceMeshSimplificationRef The class `Midpoint_placement` is a model for the `GetPlacement` concept which computes the placement as the midpoint position along the edge. 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 a6e25392da0..878278b4b69 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 @@ -2,7 +2,7 @@ namespace CGAL { namespace Surface_mesh_simplification { /*! -\ingroup PkgSurfaceMeshSimplification +\ingroup PkgSurfaceMeshSimplificationRef Simplifies `surface_mesh` in-place by collapsing edges, and returns the number of edges effectively removed. diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/NamedParameters.txt b/Surface_mesh_simplification/doc/Surface_mesh_simplification/NamedParameters.txt index 8ed97de9fab..fd764a017fa 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/NamedParameters.txt +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/NamedParameters.txt @@ -1,6 +1,6 @@ /*! \defgroup sms_namedparameters Named Parameters for Surface Mesh Simplification -\ingroup PkgSurfaceMeshSimplification +\ingroup PkgSurfaceMeshSimplificationRef In this package, some optional parameters are implemented as BGL optional named parameters (see \ref BGLNamedParameters for more information on how to use them). diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/PackageDescription.txt b/Surface_mesh_simplification/doc/Surface_mesh_simplification/PackageDescription.txt index ca6427cd49c..a288593c70a 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/PackageDescription.txt +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/PackageDescription.txt @@ -1,15 +1,15 @@ -/// \defgroup PkgSurfaceMeshSimplification Triangulated Surface Mesh Simplification Reference +/// \defgroup PkgSurfaceMeshSimplificationRef Triangulated Surface Mesh Simplification Reference /// \defgroup PkgSurfaceMeshSimplificationConcepts Concepts -/// \ingroup PkgSurfaceMeshSimplification +/// \ingroup PkgSurfaceMeshSimplificationRef /*! -\addtogroup PkgSurfaceMeshSimplification +\addtogroup PkgSurfaceMeshSimplificationRef \todo check generated documentation \cgalPkgDescriptionBegin{Triangulated Surface Mesh Simplification,PkgSurfaceMeshSimplificationSummary} \cgalPkgPicture{SMS-detail.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Fernando Cacciola} \cgalPkgDesc{This package provides an algorithm to simplify a triangulated surface mesh by edge collapsing. It is an implementation of the Turk/Lindstrom memoryless surface mesh simplification algorithm.} -\cgalPkgManuals{Chapter_Triangulated_Surface_Mesh_Simplification,PkgSurfaceMeshSimplification} +\cgalPkgManuals{Chapter_Triangulated_Surface_Mesh_Simplification,PkgSurfaceMeshSimplificationRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.3} diff --git a/Surface_mesh_skeletonization/doc/Surface_mesh_skeletonization/PackageDescription.txt b/Surface_mesh_skeletonization/doc/Surface_mesh_skeletonization/PackageDescription.txt index 2163696092f..e563a161fa4 100644 --- a/Surface_mesh_skeletonization/doc/Surface_mesh_skeletonization/PackageDescription.txt +++ b/Surface_mesh_skeletonization/doc/Surface_mesh_skeletonization/PackageDescription.txt @@ -1,9 +1,9 @@ -/// \defgroup PkgMeanCurvatureSkeleton3 Triangulated Surface Mesh Skeletonization Reference +/// \defgroup PkgMeanCurvatureSkeleton3Ref Triangulated Surface Mesh Skeletonization Reference /// \defgroup PkgMeanCurvatureSkeleton3Concepts Concepts -/// \ingroup PkgMeanCurvatureSkeleton3 +/// \ingroup PkgMeanCurvatureSkeleton3Ref /*! -\addtogroup PkgMeanCurvatureSkeleton3 +\addtogroup PkgMeanCurvatureSkeleton3Ref \cgalPkgDescriptionBegin{Triangulated Surface Mesh Skeletonization,PkgMeanCurvatureSkeleton3Summary} \cgalPkgPicture{mcfskel-small.png} \cgalPkgSummaryBegin @@ -14,7 +14,7 @@ The code is generic and works with any model of the `FaceListGraph` concept. } -\cgalPkgManuals{Chapter_3D_Surface_mesh_skeletonization,PkgMeanCurvatureSkeleton3} +\cgalPkgManuals{Chapter_3D_Surface_mesh_skeletonization,PkgMeanCurvatureSkeleton3Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{4.7} diff --git a/Surface_mesh_skeletonization/include/CGAL/Mean_curvature_flow_skeletonization.h b/Surface_mesh_skeletonization/include/CGAL/Mean_curvature_flow_skeletonization.h index 64fd82fb438..a9fec191c37 100644 --- a/Surface_mesh_skeletonization/include/CGAL/Mean_curvature_flow_skeletonization.h +++ b/Surface_mesh_skeletonization/include/CGAL/Mean_curvature_flow_skeletonization.h @@ -112,7 +112,7 @@ struct Skel_polyhedron_items_3: CGAL::Polyhedron_items_with_id_3 { } //end of namespace internal -/// \ingroup PkgMeanCurvatureSkeleton3 +/// \ingroup PkgMeanCurvatureSkeleton3Ref /// Function object that enables to extract the mean curvature /// flow skeleton of a triangulated surface mesh. /// diff --git a/Surface_mesh_skeletonization/include/CGAL/extract_mean_curvature_flow_skeleton.h b/Surface_mesh_skeletonization/include/CGAL/extract_mean_curvature_flow_skeleton.h index e49279a405d..67cba2652b5 100644 --- a/Surface_mesh_skeletonization/include/CGAL/extract_mean_curvature_flow_skeleton.h +++ b/Surface_mesh_skeletonization/include/CGAL/extract_mean_curvature_flow_skeleton.h @@ -35,7 +35,7 @@ namespace CGAL{ #if defined(DOXYGEN_RUNNING) || defined(CGAL_EIGEN3_ENABLED) -/// \ingroup PkgMeanCurvatureSkeleton3 +/// \ingroup PkgMeanCurvatureSkeleton3Ref /// @brief extracts a medially centered curve skeleton for the triangle mesh `tmesh`. /// This function uses the class CGAL::Mean_curvature_flow_skeletonization with the default parameters. /// This function is provided only if \ref thirdpartyEigen "Eigen" 3.2 (or greater) is available and `CGAL_EIGEN3_ENABLED` is defined. diff --git a/Surface_mesher/doc/Surface_mesher/PackageDescription.txt b/Surface_mesher/doc/Surface_mesher/PackageDescription.txt index df23e90f9b6..1327a4e8006 100644 --- a/Surface_mesher/doc/Surface_mesher/PackageDescription.txt +++ b/Surface_mesher/doc/Surface_mesher/PackageDescription.txt @@ -1,18 +1,18 @@ -/// \defgroup PkgSurfaceMesher3 3D Surface Mesh Generation Reference +/// \defgroup PkgSurfaceMesher3Ref 3D Surface Mesh Generation Reference /// \defgroup PkgSurfaceMesher3Concepts Concepts -/// \ingroup PkgSurfaceMesher3 +/// \ingroup PkgSurfaceMesher3Ref /// \defgroup PkgSurfaceMesher3Classes Mesh and Domain Classes -/// \ingroup PkgSurfaceMesher3 +/// \ingroup PkgSurfaceMesher3Ref /// \defgroup PkgSurfaceMesher3TagClasses Tag Classes -/// \ingroup PkgSurfaceMesher3 +/// \ingroup PkgSurfaceMesher3Ref /// \defgroup PkgSurfaceMesher3Functions Functions -/// \ingroup PkgSurfaceMesher3 +/// \ingroup PkgSurfaceMesher3Ref /// \defgroup PkgSurfaceMesher3FunctionsMakeMesh Mesh Generation @@ -24,14 +24,14 @@ /*! -\addtogroup PkgSurfaceMesher3 +\addtogroup PkgSurfaceMesher3Ref \todo check generated documentation \cgalPkgDescriptionBegin{3D Surface Mesh Generation,PkgSurfaceMesher3Summary} \cgalPkgPicture{segmented_head-small.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Laurent Rineau and Mariette Yvinec} \cgalPkgDesc{This package provides functions to generate surface meshes that interpolate smooth surfaces. The meshing algorithm is based on Delaunay refinement and provides some guarantees on the resulting mesh: the user is able to control the size and shape of the mesh elements and the accuracy of the surface approximation. There is no restriction on the topology and number of components of input surfaces. The surface mesh generator may also be used for non smooth surfaces but without guarantee. Currently, implementations are provided for implicit surfaces described as the zero level set of some function and surfaces described as a gray level set in a three-dimensional image.} -\cgalPkgManuals{Chapter_3D_Surface_Mesh_Generation,PkgSurfaceMesher3} +\cgalPkgManuals{Chapter_3D_Surface_Mesh_Generation,PkgSurfaceMesher3Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.2} diff --git a/Surface_sweep_2/doc/Surface_sweep_2/CGAL/Surface_sweep_2_algorithms.h b/Surface_sweep_2/doc/Surface_sweep_2/CGAL/Surface_sweep_2_algorithms.h index 65d4383e56d..dfc692a631c 100644 --- a/Surface_sweep_2/doc/Surface_sweep_2/CGAL/Surface_sweep_2_algorithms.h +++ b/Surface_sweep_2/doc/Surface_sweep_2/CGAL/Surface_sweep_2_algorithms.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgIntersectionOfCurves2 +\ingroup PkgIntersectionOfCurves2Ref Given a range of curves, compute all intersection points between two (or more) input curves. When the flag `report_endpoints` is `true`, @@ -20,7 +20,7 @@ OutputIterator compute_intersection_points (InputIterator curves_begin, bool report_endpoints = false); /*! -\ingroup PkgIntersectionOfCurves2 +\ingroup PkgIntersectionOfCurves2Ref Given a range of curves, compute all intersection points between two (or more) input curves. When the flag `report_endpoints` is `true`, @@ -40,7 +40,7 @@ OutputIterator compute_intersection_points (InputIterator curves_begin, Traits traits); /*! -\ingroup PkgIntersectionOfCurves2 +\ingroup PkgIntersectionOfCurves2Ref Given a range of curves, compute all \f$ x\f$-monotone subcurves that are pairwise disjoint in their interior, as induced by the input curves. @@ -57,7 +57,7 @@ OutputIterator compute_subcurves (InputIterator curves_begin, bool multiple_overlaps = false); /*! -\ingroup PkgIntersectionOfCurves2 +\ingroup PkgIntersectionOfCurves2Ref Given a range of curves, compute all \f$ x\f$-monotone subcurves that are pairwise disjoint in their interior, as induced by the input curves. @@ -76,7 +76,7 @@ OutputIterator compute_subcurves (InputIterator curves_begin, Traits traits = Default_traits()); /*! -\ingroup PkgIntersectionOfCurves2 +\ingroup PkgIntersectionOfCurves2Ref Given a range of curves, check whether there is at least one pair of curves that intersect in their interior. The function returns `true` if such @@ -88,7 +88,7 @@ bool do_curves_intersect (InputIterator curves_begin, InputIterator curves_end); /*! -\ingroup PkgIntersectionOfCurves2 +\ingroup PkgIntersectionOfCurves2Ref Given a range of curves, check whether there is at least one pair of curves that intersect in their interior. The function returns `true` if such diff --git a/Surface_sweep_2/doc/Surface_sweep_2/PackageDescription.txt b/Surface_sweep_2/doc/Surface_sweep_2/PackageDescription.txt index 131f7fa07c1..028e5e2d45d 100644 --- a/Surface_sweep_2/doc/Surface_sweep_2/PackageDescription.txt +++ b/Surface_sweep_2/doc/Surface_sweep_2/PackageDescription.txt @@ -1,13 +1,13 @@ -/// \defgroup PkgIntersectionOfCurves2 2D Intersection of Curves Reference +/// \defgroup PkgIntersectionOfCurves2Ref 2D Intersection of Curves Reference /*! -\addtogroup PkgIntersectionOfCurves2 +\addtogroup PkgIntersectionOfCurves2Ref \todo check generated documentation \cgalPkgDescriptionBegin{2D Intersection of Curves,PkgIntersectionOfCurves2Summary} \cgalPkgPicture{Curve_intersections_2.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Baruch Zukerman, Ron Wein, and Efi Fogel} \cgalPkgDesc{This package provides three free functions implemented based on the sweep-line paradigm: given a collection of input curves, compute all intersection points, compute the set of subcurves that are pairwise interior-disjoint induced by them, and check whether there is at least one pair of curves among them that intersect in their interior.} -\cgalPkgManuals{Chapter_2D_Intersection_of_Curves,PkgIntersectionOfCurves2} +\cgalPkgManuals{Chapter_2D_Intersection_of_Curves,PkgIntersectionOfCurves2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{2.4} diff --git a/TDS_2/doc/TDS_2/CGAL/Triangulation_data_structure_2.h b/TDS_2/doc/TDS_2/CGAL/Triangulation_data_structure_2.h index 47455af8bba..4409f5f7243 100644 --- a/TDS_2/doc/TDS_2/CGAL/Triangulation_data_structure_2.h +++ b/TDS_2/doc/TDS_2/CGAL/Triangulation_data_structure_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgTDS2 +\ingroup PkgTDS2Ref The class `Triangulation_data_structure_2` is a model for the `TriangulationDataStructure_2` concept. diff --git a/TDS_2/doc/TDS_2/CGAL/Triangulation_ds_face_base_2.h b/TDS_2/doc/TDS_2/CGAL/Triangulation_ds_face_base_2.h index fe921c4f1c0..f9b9784fde9 100644 --- a/TDS_2/doc/TDS_2/CGAL/Triangulation_ds_face_base_2.h +++ b/TDS_2/doc/TDS_2/CGAL/Triangulation_ds_face_base_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgTDS2 +\ingroup PkgTDS2Ref The class `Triangulation_ds_face_base_2` is a model for the concept `TriangulationDSFaceBase_2` to be used by diff --git a/TDS_2/doc/TDS_2/CGAL/Triangulation_ds_vertex_base_2.h b/TDS_2/doc/TDS_2/CGAL/Triangulation_ds_vertex_base_2.h index 80d0064167e..822a61e891d 100644 --- a/TDS_2/doc/TDS_2/CGAL/Triangulation_ds_vertex_base_2.h +++ b/TDS_2/doc/TDS_2/CGAL/Triangulation_ds_vertex_base_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgTDS2 +\ingroup PkgTDS2Ref The class `Triangulation_ds_vertex_base_2` can be used as the base vertex for a `Triangulation_data_structure_2`, it is a model of the concept diff --git a/TDS_2/doc/TDS_2/PackageDescription.txt b/TDS_2/doc/TDS_2/PackageDescription.txt index 35ca4dbe5e7..b923cf39729 100644 --- a/TDS_2/doc/TDS_2/PackageDescription.txt +++ b/TDS_2/doc/TDS_2/PackageDescription.txt @@ -1,15 +1,15 @@ -/// \defgroup PkgTDS2 2D Triangulation Data Structure Reference +/// \defgroup PkgTDS2Ref 2D Triangulation Data Structure Reference /// \defgroup PkgTDS2Concepts Concepts -/// \ingroup PkgTDS2 +/// \ingroup PkgTDS2Ref /*! -\addtogroup PkgTDS2 +\addtogroup PkgTDS2Ref \todo check generated documentation \cgalPkgDescriptionBegin{2D Triangulation Data Structure,PkgTDS2Summary} \cgalPkgPicture{tds_small.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Sylvain Pion and Mariette Yvinec} \cgalPkgDesc{This package provides a data structure to store a two-dimensional triangulation that has the topology of a two-dimensional sphere. The package acts as a container for the vertices and faces of the triangulation and provides basic combinatorial operation on the triangulation. } -\cgalPkgManuals{Chapter_2D_Triangulation_Data_Structure,PkgTDS2} +\cgalPkgManuals{Chapter_2D_Triangulation_Data_Structure,PkgTDS2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{2.2} diff --git a/TDS_3/doc/TDS_3/PackageDescription.txt b/TDS_3/doc/TDS_3/PackageDescription.txt index 9167af3f17a..e89ca7540e4 100644 --- a/TDS_3/doc/TDS_3/PackageDescription.txt +++ b/TDS_3/doc/TDS_3/PackageDescription.txt @@ -1,20 +1,20 @@ -/// \defgroup PkgTDS3 3D Triangulation Data Structure Reference +/// \defgroup PkgTDS3Ref 3D Triangulation Data Structure Reference /// \defgroup PkgTDS3Concepts Concepts -/// \ingroup PkgTDS3 +/// \ingroup PkgTDS3Ref /// \defgroup PkgTDS3Classes Classes -/// \ingroup PkgTDS3 +/// \ingroup PkgTDS3Ref /*! -\addtogroup PkgTDS3 +\addtogroup PkgTDS3Ref \todo check generated documentation \cgalPkgDescriptionBegin{3D Triangulation Data Structure,PkgTDS3Summary} \cgalPkgPicture{tds3_small.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Clément Jamin, Sylvain Pion and Monique Teillaud} \cgalPkgDesc{This package provides a data structure to store a three-dimensional triangulation that has the topology of a three-dimensional sphere. The package acts as a container for the vertices and cells of the triangulation and provides basic combinatorial operations on the triangulation.} -\cgalPkgManuals{Chapter_3D_Triangulation_Data_Structure,PkgTDS3} +\cgalPkgManuals{Chapter_3D_Triangulation_Data_Structure,PkgTDS3Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{2.1} diff --git a/Three/doc/Three/PackageDescription.txt b/Three/doc/Three/PackageDescription.txt index 3347d8e1677..ee880d67e50 100644 --- a/Three/doc/Three/PackageDescription.txt +++ b/Three/doc/Three/PackageDescription.txt @@ -1,14 +1,14 @@ -/// \defgroup PkgThree Three +/// \defgroup PkgThreeRef Three /// /*! -\addtogroup PkgThree +\addtogroup PkgThreeRef \cgalPkgDescriptionBegin{Three,PkgThreeSummary} \cgalPkgPicture{pkg-small.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Laurent Rineau, Sebastien Loriot, Andreas Fabri, Maxime Gimeno} \cgalPkgDesc{This package provides base classes for building a plugin. } -\cgalPkgManuals{Chapter_Three,PkgThree} +\cgalPkgManuals{Chapter_Three,PkgThreeRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{4.8} diff --git a/Three/include/CGAL/Three/Scene_interface.h b/Three/include/CGAL/Three/Scene_interface.h index 065d30e7c0f..b6e39f9feb6 100644 --- a/Three/include/CGAL/Three/Scene_interface.h +++ b/Three/include/CGAL/Three/Scene_interface.h @@ -26,7 +26,7 @@ #define SCENE_INTERFACE_H #include /*! -* \ingroup PkgThree +* \ingroup PkgThreeRef * The RenderingMode determines which of an item's primitives must be drawn. * It can be Points, PointsPlusNormals, Wireframe, Flat, FlatPlusEdges, or Gouraud. * - Points, PointsPlusNormals, and Wireframe have no light model. diff --git a/Triangulation/doc/Triangulation/PackageDescription.txt b/Triangulation/doc/Triangulation/PackageDescription.txt index b3bf73dd86f..a74336a10f8 100644 --- a/Triangulation/doc/Triangulation/PackageDescription.txt +++ b/Triangulation/doc/Triangulation/PackageDescription.txt @@ -1,18 +1,18 @@ -/// \defgroup PkgTriangulations dD Triangulations +/// \defgroup PkgTriangulationsRef dD Triangulations /// \defgroup PkgTriangulationsConcepts Concepts -/// \ingroup PkgTriangulations +/// \ingroup PkgTriangulationsRef /// \defgroup PkgTriangulationsTriangulationClasses Triangulation Classes -/// \ingroup PkgTriangulations +/// \ingroup PkgTriangulationsRef /// \defgroup PkgTriangulationsTraitsClasses Traits Classes -/// \ingroup PkgTriangulations +/// \ingroup PkgTriangulationsRef /// \defgroup PkgTriangulationsVertexCellClasses Vertex, Face and Cell Classes -/// \ingroup PkgTriangulations +/// \ingroup PkgTriangulationsRef /*! -\addtogroup PkgTriangulations +\addtogroup PkgTriangulationsRef \cgalPkgDescriptionBegin{dD Triangulations,PkgTriangulationsSummary} \cgalPkgPicture{Hypertriangle.png} \cgalPkgSummaryBegin @@ -23,7 +23,7 @@ can be specified at compile-time or at run-time. Specifically, it provides a data structure to store the triangulations, and two classes to handle triangulations and Delaunay triangulations of point sets. Point location and point insertion are supported. The Delaunay triangulation also supports point removal.} -\cgalPkgManuals{Chapter_Triangulations,PkgTriangulations} +\cgalPkgManuals{Chapter_Triangulations,PkgTriangulationsRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{4.6} diff --git a/Triangulation_2/doc/Triangulation_2/PackageDescription.txt b/Triangulation_2/doc/Triangulation_2/PackageDescription.txt index 0984fbd61b3..15544296896 100644 --- a/Triangulation_2/doc/Triangulation_2/PackageDescription.txt +++ b/Triangulation_2/doc/Triangulation_2/PackageDescription.txt @@ -1,20 +1,20 @@ -/// \defgroup PkgTriangulation2 2D Triangulation Reference +/// \defgroup PkgTriangulation2Ref 2D Triangulation Reference /// \defgroup PkgTriangulation2Concepts Concepts -/// \ingroup PkgTriangulation2 +/// \ingroup PkgTriangulation2Ref /// \defgroup PkgTriangulation2TriangulationClasses Triangulation Classes -/// \ingroup PkgTriangulation2 +/// \ingroup PkgTriangulation2Ref /// \defgroup PkgTriangulation2TraitsClasses Traits Classes -/// \ingroup PkgTriangulation2 +/// \ingroup PkgTriangulation2Ref /// \defgroup PkgTriangulation2VertexFaceClasses Vertex and Face Classes -/// \ingroup PkgTriangulation2 +/// \ingroup PkgTriangulation2Ref /// \defgroup PkgTriangulation2Miscellaneous Miscellaneous -/// \ingroup PkgTriangulation2 +/// \ingroup PkgTriangulation2Ref /*! Draw. \code @@ -22,17 +22,17 @@ \endcode */ /// \defgroup PkgDrawTriangulation2 Draw a Triangulation 2 -/// \ingroup PkgTriangulation2 +/// \ingroup PkgTriangulation2Ref /*! -\addtogroup PkgTriangulation2 +\addtogroup PkgTriangulation2Ref \todo check generated documentation \cgalPkgDescriptionBegin{2D Triangulation,PkgTriangulation2Summary} \cgalPkgPicture{cdt2d-small.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Mariette Yvinec} \cgalPkgDesc{This package allows to build and handle various triangulations for point sets two dimensions. Any \cgal triangulation covers the convex hull of its vertices. Triangulations are built incrementally and can be modified by insertion or removal of vertices. They offer point location facilities. The package provides plain triangulation (whose faces depend on the insertion order of the vertices) and Delaunay triangulations. Regular triangulations are also provided for sets of weighted points. Delaunay and regular triangulations offer nearest neighbor queries and primitives to build the dual Voronoi and power diagrams. Finally, constrained and Delaunay constrained triangulations allows to force some constrained segments to appear as edges of the triangulation. Several versions of constrained and Delaunay constrained triangulations are provided: some of them handle intersections between input constraints segment while others do not. } -\cgalPkgManuals{Chapter_2D_Triangulations,PkgTriangulation2} +\cgalPkgManuals{Chapter_2D_Triangulations,PkgTriangulation2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{0.9} @@ -66,7 +66,7 @@ of triangulation data structure acting as a container for faces and vertices while taking care of the combinatorial aspects of the triangulation. The concepts and models relative to the triangulation data structure -are described in Chapter \ref PkgTDS2 "2D Triangulation Data Structure". +are described in Chapter \ref PkgTDS2Ref "2D Triangulation Data Structure". \cgalClassifedRefPages diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/link_to_face_graph.h b/Triangulation_3/doc/Triangulation_3/CGAL/link_to_face_graph.h index 4a61bbdf8ae..600ec0441e8 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/link_to_face_graph.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/link_to_face_graph.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgTriangulation3 +\ingroup PkgTriangulation3Ref fills the face graph `tm` with the link of triangulation vertex `vh`. diff --git a/Triangulation_3/doc/Triangulation_3/PackageDescription.txt b/Triangulation_3/doc/Triangulation_3/PackageDescription.txt index d24aa743c3b..a3df66f26fa 100644 --- a/Triangulation_3/doc/Triangulation_3/PackageDescription.txt +++ b/Triangulation_3/doc/Triangulation_3/PackageDescription.txt @@ -1,17 +1,17 @@ -/// \defgroup PkgTriangulation3 3D Triangulations Reference +/// \defgroup PkgTriangulation3Ref 3D Triangulations Reference /// \defgroup PkgTriangulation3Concepts Concepts -/// \ingroup PkgTriangulation3 +/// \ingroup PkgTriangulation3Ref /// \defgroup PkgTriangulation3TriangulationClasses Triangulation Classes -/// \ingroup PkgTriangulation3 +/// \ingroup PkgTriangulation3Ref /// \defgroup PkgTriangulation3TraitsClasses Traits Classes -/// \ingroup PkgTriangulation3 +/// \ingroup PkgTriangulation3Ref /// \defgroup PkgTriangulation3VertexCellClasses Vertex and Cell Classes -/// \ingroup PkgTriangulation3 +/// \ingroup PkgTriangulation3Ref /*! Draw. \code @@ -19,16 +19,16 @@ \endcode */ /// \defgroup PkgDrawTriangulation3 Draw a Triangulation 3 -/// \ingroup PkgTriangulation3 +/// \ingroup PkgTriangulation3Ref /*! -\addtogroup PkgTriangulation3 +\addtogroup PkgTriangulation3Ref \cgalPkgDescriptionBegin{3D Triangulations,PkgTriangulation3Summary} \cgalPkgPicture{twotets.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Clément Jamin, Sylvain Pion and Monique Teillaud} \cgalPkgDesc{This package allows to build and handle triangulations for point sets in three dimensions. Any \cgal triangulation covers the convex hull of its vertices. Triangulations are build incrementally and can be modified by insertion, displacements or removal of vertices. They offer point location facilities. The package provides plain triangulation (whose faces depends on the insertion order of the vertices) and Delaunay triangulations. Regular triangulations are also provided for sets of weighted points. Delaunay and regular triangulations offer nearest neighbor queries and primitives to build the dual Voronoi and power diagrams. Optionally, the main Delaunay and regular triangulation algorithms (insert, remove) support multi-core shared-memory architectures to take advantage of available parallelism.} -\cgalPkgManuals{Chapter_3D_Triangulations,PkgTriangulation3} +\cgalPkgManuals{Chapter_3D_Triangulations,PkgTriangulation3Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{2.1} diff --git a/Visibility_2/doc/Visibility_2/PackageDescription.txt b/Visibility_2/doc/Visibility_2/PackageDescription.txt index 3b3a2ad8672..4b822f96c03 100644 --- a/Visibility_2/doc/Visibility_2/PackageDescription.txt +++ b/Visibility_2/doc/Visibility_2/PackageDescription.txt @@ -1,20 +1,20 @@ -/// \defgroup PkgVisibility_2 Visibility_2 Reference +/// \defgroup PkgVisibility_2Ref Visibility_2 Reference /// \defgroup PkgVisibility_2Concepts Concepts -/// \ingroup PkgVisibility_2 +/// \ingroup PkgVisibility_2Ref /// \defgroup PkgVisibility_2Classes Classes -/// \ingroup PkgVisibility_2 +/// \ingroup PkgVisibility_2Ref /*! -\addtogroup PkgVisibility_2 +\addtogroup PkgVisibility_2Ref \cgalPkgDescriptionBegin{2D Visibility Computation,PkgVisibility_2Summary} \cgalPkgPicture{visibility-teaser-thumbnail.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Michael Hemmer, Kan Huang, Francisc Bungiu, Ning Xu} \cgalPkgDesc{This package provides several variants to compute the visibility area of a point within polygonal regions in two dimensions.} -\cgalPkgManuals{Chapter_2D_Visibility_Computation,PkgVisibility_2} +\cgalPkgManuals{Chapter_2D_Visibility_Computation,PkgVisibility_2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{4.7} diff --git a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Identity_policy_2.h b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Identity_policy_2.h index 9360de7f479..fab2cd8ae00 100644 --- a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Identity_policy_2.h +++ b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Identity_policy_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgVoronoiDiagramAdaptor2 +\ingroup PkgVoronoiDiagramAdaptor2Ref The class `Identity_policy_2` provides a model for the `AdaptationPolicy_2` concept. The first template parameter of the `Identity_policy_2` class must be a diff --git a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Voronoi_diagram_2.h b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Voronoi_diagram_2.h index dd98107e487..cc36c9326a1 100644 --- a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Voronoi_diagram_2.h +++ b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Voronoi_diagram_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgVoronoiDiagramAdaptor2 +\ingroup PkgVoronoiDiagramAdaptor2Ref The class `Voronoi_diagram_2` provides an adaptor that enables us to view a triangulated Delaunay graph as their dual subdivision, the @@ -34,7 +34,7 @@ public: /*! - \ingroup PkgVoronoiDiagramAdaptor2 + \ingroup PkgVoronoiDiagramAdaptor2Ref The class `Face` is the class provided by the `Voronoi_diagram_2` class for Voronoi faces. Below we @@ -162,7 +162,7 @@ public: /*! - \ingroup PkgVoronoiDiagramAdaptor2 + \ingroup PkgVoronoiDiagramAdaptor2Ref The class `Halfedge` is the class provided by the `Voronoi_diagram_2` class for Voronoi halfedges. @@ -403,7 +403,7 @@ public: /*! - \ingroup PkgVoronoiDiagramAdaptor2 + \ingroup PkgVoronoiDiagramAdaptor2Ref The class `Vertex` is the Voronoi vertex class provided by the class `Voronoi_diagram_2` class. Below we present its interface. diff --git a/Voronoi_diagram_2/doc/Voronoi_diagram_2/PackageDescription.txt b/Voronoi_diagram_2/doc/Voronoi_diagram_2/PackageDescription.txt index 6c2c370f9ad..a6f4523bccb 100644 --- a/Voronoi_diagram_2/doc/Voronoi_diagram_2/PackageDescription.txt +++ b/Voronoi_diagram_2/doc/Voronoi_diagram_2/PackageDescription.txt @@ -1,26 +1,26 @@ -/// \defgroup PkgVoronoiDiagramAdaptor2 2D Voronoi Diagram Adaptor Reference +/// \defgroup PkgVoronoiDiagramAdaptor2Ref 2D Voronoi Diagram Adaptor Reference /// \defgroup PkgVoronoiDiagramAdaptor2Concepts Concepts -/// \ingroup PkgVoronoiDiagramAdaptor2 +/// \ingroup PkgVoronoiDiagramAdaptor2Ref /// \defgroup PkgVoronoiDiagramAdaptor2Points Voronoi Diagram of Points -/// \ingroup PkgVoronoiDiagramAdaptor2 +/// \ingroup PkgVoronoiDiagramAdaptor2Ref /// \defgroup PkgVoronoiDiagramAdaptor2Segments Voronoi Diagram of Segments -/// \ingroup PkgVoronoiDiagramAdaptor2 +/// \ingroup PkgVoronoiDiagramAdaptor2Ref /// \defgroup PkgVoronoiDiagramAdaptor2Disks Voronoi Diagram of Disks -/// \ingroup PkgVoronoiDiagramAdaptor2 +/// \ingroup PkgVoronoiDiagramAdaptor2Ref /*! -\addtogroup PkgVoronoiDiagramAdaptor2 +\addtogroup PkgVoronoiDiagramAdaptor2Ref \todo check generated documentation \cgalPkgDescriptionBegin{2D Voronoi Diagram Adaptor,PkgVoronoiDiagramAdaptor2Summary} \cgalPkgPicture{voronoi.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Menelaos Karavelas} \cgalPkgDesc{The 2D Voronoi diagram adaptor package provides an adaptor that adapts a 2-dimensional triangulated Delaunay graph to the corresponding Voronoi diagram, represented as a doubly connected edge list (DCEL) data structure. The adaptor has the ability to automatically eliminate, in a consistent manner, degenerate features of the Voronoi diagram, that are artifacts of the requirement that Delaunay graphs should be triangulated even in degenerate configurations. Depending on the type of operations that the underlying Delaunay graph supports, the adaptor allows for the incremental or dynamic construction of Voronoi diagrams and can support point location queries. } -\cgalPkgManuals{Chapter_2D_Voronoi_Diagram_Adaptor,PkgVoronoiDiagramAdaptor2} +\cgalPkgManuals{Chapter_2D_Voronoi_Diagram_Adaptor,PkgVoronoiDiagramAdaptor2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.2}