Mesh_3: Fix Documentation Glitches #9283
Conversation
| /// \name Types imported from the geometric traits class | ||
| ///@{ | ||
| /// The point type of the geometric traits class | ||
| /// @todo this should be BGT where we have to add Iso_cuboid in the concept |
There was a problem hiding this comment.
Why do we not document that the types come from BGT @janetournois ?
| /*! \brief Construction from a function, a bounding object and a relative error bound. | ||
| * | ||
| * \tparam Function a type compatible with `Labeling_function` | ||
| * \tparam Function a type compatible with `Labeling_function` @todo fix this as this is no longer a template parameter |
There was a problem hiding this comment.
The labeling functions is no longer a template parameter @janetournois
|
When did we deprecate this? Maybe we can remove it in this PR. |
|
Is it correct that here we refer to the Surface_mesher package @janetournois |
I don't think so. What part of the page do you refer to? |
I refer to the sentence "This parameter stands for a model of the concept ImplicitFunction described in the surface mesh generation package" |
then yes, it is about |
This comment was marked as outdated.
This comment was marked as outdated.
|
The documentation is built. It will be available, after a few minutes, here: https://cgal.github.io/9283/v0/Manual/index.html |
| \suitesparse is a set of sparse-matrix-related packages written or co-authored by Tim Davis, available at <A HREF="https://github.com/DrTimothyAldenDavis/SuiteSparse">https://github.com/DrTimothyAldenDavis/SuiteSparse</A>. | ||
|
|
||
| \suitesparse is used by the Orbifold Tutte Embedding and ARAP parametrization, i.e., in the surface parametrization package. | ||
| \suitesparse is used by the Orbifold Tutte Embedding and ARAP parametrization, i.e., in the \ref PkgSurfaceMeshParametrization package. |
There was a problem hiding this comment.
| \suitesparse is used by the Orbifold Tutte Embedding and ARAP parametrization, i.e., in the \ref PkgSurfaceMeshParametrization package. | |
| \suitesparse is used by the Orbifold Tutte Embedding and ARAP parameterization, i.e., in the \ref PkgSurfaceMeshParameterization package. |
4 participants
Summary of Changes
Template parameters must be in CamelCase
Fix template parameters in the package description
Todo
Release Management