Tutorial: 2D Triangulations

[afabri]

Summary of Changes

Add a tutorial for getting started with 2D Triangulations in an easier way than the User Manual.
This could as well become a section in the User Manual.

Link to the html page.

[github-actions]

The documentation is built. It will be available, after a few minutes, here: https://cgal.github.io/8739/v0/Manual/index.html

[sloriot]

@afabri what is the status?

[sloriot]

shouldn't you mention that the points are not inserted in the order of the range?

[sloriot]

simply mention ranges?

[afabri]

/force-build:v0

[github-actions]

There was an error while building the doc:

/home/runner/work/cgal/cgal/Triangulation_2/doc/Triangulation_2/Triangulation_2.txt:26: warning: unable to resolve reference to 'Section_2D_Triangulations_Constrained:' for \ref command

https://github.com/CGAL/cgal/actions/runs/20921859889

[afabri]

/force-build:v0

[github-actions]

The documentation is built. It will be available, after a few minutes, here: https://cgal.github.io/8739/v0/Manual/index.html

[afabri]

/force-build:v0

[github-actions]

The documentation is built. It will be available, after a few minutes, here: https://cgal.github.io/8739/v0/Manual/index.html

[afabri]

@albert-github can you help us to understand what is necessary for doxygen that it adds a section Examples in a reference manual page.

[sloriot]

@albert-github can you help us to understand what is necessary for doxygen that it adds a section Examples in a reference manual page.

What do you mean?

[afabri]

/force-build:v0

[github-actions]

The documentation is built. It will be available, after a few minutes, here: https://cgal.github.io/8739/v0/Manual/index.html

[albert-github]

@afabri

I don't get the question either which example where should it be etc.
Maybe this will help a little: the examples section is in doxygen based on the \examples command, so when the command \example is given you will also see and example section, see e.g. the following quick example I made (I didn't compile it to see whether or not it is 100% valid code): example.tar.gz

[albert-github]

The section numbers are spevial to CGAL, the way it is re-implemented here looses the possibility to refer to a section and the possibility of the TOC .

[MaelRL]

@albert-github @sloriot

The question was "what does it take for the list of examples using this function to show up at the bottom of the documentation of a class or a function".

For example :

CGAL::Polygon_mesh_processing::repair_polygon_soup().

--> used in the example repair_polygon_soup_example.cpp, which is in PMP/examples.txt

but there is nothing at the bottom of the function's documentation, whereas we'd expect references to examples at the bottom of the function documentation:

---

---

But in fact it seems related to the fact that there is no link in the doc output:

---

---

and that seems to be related to the fact that we use a namespace alias:

namespace PMP = CGAL::Polygon_mesh_processing;

If I change the example and put "CGAL::Polygon_mesh_processing::repair_polygon_soup", then the link shows up:

---

---

and I get the example showing in the function doc:

---

---

So the questions are:

• What can we do so links show up when using namespace aliases ?
• Are there other conditions such that the example links do not appear at the bottom of functions, for example for class template member functions?
• How does doxygen select which example to show in the list when there are many .cpp using that function? (CGAL::IO::read_polygon_mesh for example).

Thanks!