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.

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

Workaround missing links #8365

Merged
merged 3 commits into from
Jul 23, 2024
Merged

Workaround missing links #8365

merged 3 commits into from
Jul 23, 2024

Conversation

sloriot
Copy link
Member

@sloriot sloriot commented Jul 22, 2024

No description provided.

@sloriot sloriot changed the base branch from master to 5.5.x-branch July 22, 2024 07:55
@albert-github
Copy link
Contributor

Note the problem looks like to be present in BGL/doc/BGL/BGL.txt as well.

@albert-github
Copy link
Contributor

albert-github commented Jul 22, 2024

I was still a bit intrigued by the problem and it looks like doxygen gets a bit confused due to the, undocumented, definitions at the lines 37 and 122. The definition at line 188 is documented.
Would it be possible to either:

  • move the function (plus its documentation) from line 188 before the functions on the lines 37 and 122
  • put the functions from the lines 37 and 122 in a #ifndef DOXYGEN_RUNING ... #endif block
    (non related side note the DOXYGEN_RUNNING is defined in BaseDoxyfile.in but also in Kinetic_space_partition/Doxyfile.in and Kinetic_surface_reconstruction/Doxyfile.in I don't think the later 2 definitions shouldn't be there)

Analogous for the other function.

@sloriot
Copy link
Member Author

sloriot commented Jul 23, 2024

Successfully tested in CGAL-6.0-Ic-294

@sloriot sloriot added this to the 5.5.5 milestone Jul 23, 2024
@sloriot sloriot merged commit 747e6a5 into CGAL:5.5.x-branch Jul 23, 2024
8 checks passed
@sloriot sloriot deleted the BGL-doc branch September 4, 2024 13:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants