-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Description
Issue Details
If you write in the document:
\tparam x is a model of `y`.
and x is registered, x becomes a link; see e.g., CGAL::expand_face_selection, and look for FaceGraph and OutputIterator.
One may think that this is desired. I disagree.
However, even if is, there must be a way to suppress the generation of the link.
Adding % as a prefix does not work. (Actually, it adds a visible '%', which suppresses the link, but also alters the displayed string....)
A common case where this error may show up is when a class template or a template function has a template parameter that can be substituted by a kernel. We often use the token Kernel to refer to the template parameter (as in Polygon_2<Kernel, Container>).
In the doc we would write:
\tparam Kernel is a model of the concept `PolygonTraits`.
Also, \tparam is missing in many pages.
It would be nice to make a global pass and
(ii) add the missing \tparam's, and
(ii) give them all a canonical look (of the form above).
This should probably be split out and becomes an issue of its own.
Environment
- Operating system (Windows/Mac/Linux, 32/64 bits):
- Compiler:
- Release or debug mode:
- Specific flags used (if any):
- CGAL version:
- Boost version:
- Other libraries versions if used (Eigen, TBB, etc.):