CGAL / cgal

The public CGAL repository, see the README below
https://github.com/CGAL/cgal#readme
Other
4.86k stars 1.38k forks source link

Generator: missing link #6885

Closed albert-github closed 1 year ago

albert-github commented 1 year ago

In the file Generator/classCGAL_1_1Pointsonsegment__2.html I see(made links red so they are better visible):

image

Is this correct / intended or an omission in the relevant include file?

See file: Generator/doc/Generator/CGAL/point_generators_2.h

afabri commented 1 year ago

It must be points_on_segment_2.

afabri commented 1 year ago

And here the CGAL:: namespace prefix is missing for the See Also item.

Is there a new warning feature in a doxygen version that allows you to spot errors?

afabri commented 1 year ago

There are also occurences of std::random_shuffle. First there should be (). Then we maybe should write CGAL::cpp98::random_shuffle() so that it links here.

albert-github commented 1 year ago

No there is no warning for this, I'm doing a quick browse ( :-( )through a number of files based on the fact that I was missing some " and that some documentation was garbled.

Where should the CGAL::points_on_segment_2 point to ?

Do you make the relevant PRs?

albert-github commented 1 year ago

Note in Generator/classCGAL_1_1Randompointsonsegment2.html the See Also section mentions CGAL::Points_on_segment_2<Point_2>

afabri commented 1 year ago

Adding the _2 suffix makes that it links automatically to here. And there is the class with capital P and the function with lower case p.

afabri commented 1 year ago

I can make the PR. Please confirm so that we do not double work.

albert-github commented 1 year ago

@afabri please make the PR for the mentioned cases