backtick and whitespace

This commit is contained in:
Andreas Fabri 2022-11-23 10:44:13 +00:00
parent 16a89b8d01
commit f06bbd7313
5 changed files with 8 additions and 9 deletions

View File

@ -8,7 +8,7 @@ namespace CGAL {
\author Julian Stahl and Daniel Zint
[PA] : I recommend to select a more complex example (medical?), use a white background instead of default Meshlab one and superimpose the mesh edges in black.
[PA] : I recommend to select a more complex example (medical?), use a white background instead of default Meshlab one and superimpose the mesh edges in black.
\cgalFigureAnchor{isosurfacing_bunny_offset}
<center>
<img src="bunny_offset.gif" style="max-width:50%;"/>
@ -25,7 +25,7 @@ TODO: add a context and motivation: when do you need MC or dual contouring? what
TODO: stick to 'field' throughout the whole documentation, and leave the term 'function' for C++ function. This is valid for all terms: introduce them and do not interchange with others throughout the documentation.
TODO: Make sure you you clearly state that the input field is sampled.
This package provides isosurfacing algorithms that compute a surface mesh approximating an isosurface of a scalar field defined over an input 3D domain.
This package provides isosurfacing algorithms that compute a surface mesh approximating an isosurface of a scalar field defined over an input 3D domain.
An isosurface is defined as the points of constant value of this scalar field, i.e. a level-set. Such a constant value, referred to as isovalue, is user-defined. For well-behaved scalar fields (e.g., non-zero gradient), the above level-set is a surface.
Depending on the isosurfacing method and the input data structure, the output is either a triangular, a quadrilateral, or a higher degree polygonal surface mesh represented as an indexed face set. The output may also be empty when the isosurface is absent from the sampled input scalar field.
@ -196,6 +196,5 @@ The input mesh is stored into an `AABB_tree` data structure to allow fast distan
\cgalExample{Isosurfacing_3/dual_contouring_mesh_offset.cpp}
*/
} /* namespace CGAL */

View File

@ -48,7 +48,7 @@ public:
* \brief Template class for a gradient that is calculated using finite differences.
*
* \details This gradient function evaluates an implicit value function at six points
* that are a given distance delta away from the queried point.
* that are a given distance `delta` away from the queried point.
*
* \tparam GeomTraits the traits for this gradient.
*
@ -90,7 +90,7 @@ private:
/**
* \ingroup PkgIsosurfacing3Ref
*
* \brief Template class for a gradient that is stored in a Cartesian_grid_3.
* \brief Template class for a gradient that is stored in a `Cartesian_grid_3`.
*
* \details The gradient at any point is calculated using trilinear interpolation.
*

View File

@ -46,7 +46,7 @@ namespace Isosurfacing {
* \param domain the domain providing input data and its topology
* \param iso_value value of the isosurface
* \param points points making the polygons of the indexed face set
* \param polygons each element in the vector describes a polygon using the indices of the points in points
* \param polygons each element in the vector describes a polygon using the indices of the points in `points`
* \param positioning the functor dealing with vertex positioning inside a voxel
*/
template <typename Concurrency_tag = Sequential_tag, class Domain_, class PointRange, class PolygonRange,

View File

@ -30,13 +30,13 @@ using Explicit_cartesian_grid_domain = Base_domain<GeomTraits, Grid_topology, Ca
/**
* \ingroup PkgIsosurfacing3Ref
*
* \brief Creates a domain from a Cartesian_grid_3 that can be used as input for isosurfacing algorithms.
* \brief Creates a domain from a `Cartesian_grid_3` that can be used as input for isosurfacing algorithms.
*
* \details
*
* \tparam GeomTraits the traits type
*
* \param grid the cartesian grid containing input data
* \param grid the %Cartesian grid containing input data
* \param gradient a function that describes the gradient of the data
*/
template <class GeomTraits, typename Gradient_ = Zero_gradient<GeomTraits>>

View File

@ -32,7 +32,7 @@ using Implicit_cartesian_grid_domain =
/**
* \ingroup PkgIsosurfacing3Ref
*
* \brief Creates a domain from a Cartesian_grid_3 that can be used as input for isosurfacing algorithms.
* \brief Creates a domain from a `Cartesian_grid_3` that can be used as input for isosurfacing algorithms.
*
* \details
*