Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Box_intersection_d: Fix doc link #7717

Merged
merged 5 commits into from
Oct 16, 2023
Merged

Box_intersection_d: Fix doc link #7717

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
11c8b17
Box_intersection_d: Fix doc link
afabri Sep 17, 2023
7500e80
Fix typo
afabri Sep 18, 2023
c140a5d
Add \cgalCRPSection{Enumerations}
afabri Sep 18, 2023
91f0aee
Move section
afabri Sep 21, 2023
e18026d
linking in the doc
afabri Sep 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Box_intersection_d/doc/Box_intersection_d/CGAL/Box_intersection_d/Box_traits_d.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,12 @@ Box_traits_d();


/*!
\ingroup PkgBoxIntersectionDFunctions
\ingroup PkgBoxIntersectionDEnums
*/
enum Setting { COMPLETE, BIPARTITE };

/*!
\ingroup PkgBoxIntersectionDFunctions
\ingroup PkgBoxIntersectionDEnums
*/
enum Topology { HALF_OPEN, CLOSED };

Expand Down
4 changes: 3 additions & 1 deletion Box_intersection_d/doc/Box_intersection_d/PackageDescription.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
/// \defgroup PkgBoxIntersectionDConcepts Concepts
/// \ingroup PkgBoxIntersectionDRef

/// \defgroup PkgBoxIntersectionDEnums Rnumerations
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rnumerations -> Enumerations

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

stupid me.
I am also wondering if we do not have to add a \cgalCRPSection{Enumerations}. Do we have a canonical order for those? In Arrangements the enums come before the concepts.

Copy link
Contributor

@albert-github albert-github Sep 18, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When you mean with canonical something like cgalEnumerations I don't think so. A grep over BaseDoxyfile.in for cgalCRPSection just gave cgalCRPSection{1}=<h2>\1</h2>.
There are quite a few usages of cgalCRPSection though and when just looking for enumeration types I found the usages:

  • Enum
  • Enums
  • Enumerations
  • Constants and Enumerations

This cannot be correct (I think):

Arrangement_on_surface_2/doc/Arrangement_on_surface_2/PackageDescription.txt:\cgalCRPSection{Enumerations}
Circular_kernel_3/doc/Circular_kernel_3/PackageDescription.txt:\cgalCRPSection{Constants and Enumerations}
Cone_spanners_2/doc/Cone_spanners_2/PackageDescription.txt:\cgalCRPSection{Enumerations}
Kernel_23/doc/Kernel_23/PackageDescription.txt:\cgalCRPSection{Constants and Enumerations}
Mesh_2/doc/Mesh_2/PackageDescription.txt:\cgalCRPSection{Enumerations}
Mesh_3/doc/Mesh_3/PackageDescription.txt:\cgalCRPSection{Enumerations}
Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/PackageDescription.txt:\cgalCRPSection{Enums}
Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/PackageDescription.txt:\cgalCRPSection{Enums}
Ridges_3/doc/Ridges_3/PackageDescription.txt:\cgalCRPSection{Enums}
Stream_support/doc/Stream_support/PackageDescription.txt:\cgalCRPSection{Enum}
Surface_mesh_shortest_path/doc/Surface_mesh_shortest_path/PackageDescription.txt:\cgalCRPSection{Enums}
Triangulation/doc/Triangulation/PackageDescription.txt:\cgalCRPSection{Enums}
Triangulation_2/doc/Triangulation_2/PackageDescription.txt:\cgalCRPSection{Enum}
Triangulation_3/doc/Triangulation_3/PackageDescription.txt:\cgalCRPSection{Enums}
Triangulation_on_sphere_2/doc/Triangulation_on_sphere_2/PackageDescription.txt:\cgalCRPSection{Enum}

In all there I quickly found 391 usages of cgalCRPSection with 168 unique values, I used (a.o.):

grep cgalCRPSection -r [A-Z]* | grep -v "Documentation"  | sed -e "s/[^:]*://" | sort | uniq

and see that there are more catagories with "double" names (see e.g. Traits...)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was more wondering about the order of the sections
image

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The order is something doxygen cannot enforce and has to be done by means of "coding standards" and can be checked by part the "grep" I gave (i.e. the part: grep cgalCRPSection -r [A-Z]* | grep -v "Documentation") and checking whether or not the order is OK (script).

/// \ingroup PkgBoxIntersectionDRef

/// \defgroup PkgBoxIntersectionDClasses Classes
/// \ingroup PkgBoxIntersectionDRef

Expand Down Expand Up @@ -56,4 +59,3 @@
- `CGAL::box_self_intersection_all_pairs_d`

*/