mirror of https://github.com/CGAL/cgal
Doc fixes
This commit is contained in:
Mael Rouxel-Labbé
parent
cf648ed37c
commit
02fba3afd6
|
|
@ -38,7 +38,7 @@ public:
|
|||
/// @{
|
||||
|
||||
/*!
|
||||
gets the gradient at a position
|
||||
gets the gradient at the position `p`
|
||||
*/
|
||||
Vector_3 gradient(const Geom_traits::Point_3& p) const;
|
||||
|
||||
|
|
|
|||
|
|
@ -91,37 +91,37 @@ public:
|
|||
Geom_traits geom_traits();
|
||||
|
||||
/*!
|
||||
gets the position of a vertex in 3D space
|
||||
gets the 3D position of the vertex `v`
|
||||
*/
|
||||
Point_3 point(const Vertex_descriptor& v) const;
|
||||
|
||||
/*!
|
||||
gets the value of the implicit field at a vertex
|
||||
gets the value of the implicit field at the vertex `v`
|
||||
*/
|
||||
FT value(const Vertex_descriptor& v) const;
|
||||
|
||||
/*!
|
||||
gets the two vertices incident to an edge
|
||||
gets the two vertices incident to the edge `e`
|
||||
*/
|
||||
Vertices_incident_to_edge incident_vertices(const Edge_descriptor& e) const;
|
||||
|
||||
/*!
|
||||
gets all cells incident to an edge
|
||||
gets all cells incident to the edge `e`
|
||||
*/
|
||||
Cells_incident_to_edge incident_cells(const Edge_descriptor& e) const;
|
||||
|
||||
/*!
|
||||
gets all vertices of the a cell
|
||||
gets all vertices of the cell `c`
|
||||
*/
|
||||
Cell_vertices cell_vertices(const Cell_descriptor& c) const;
|
||||
|
||||
/*!
|
||||
gets all edges of the cell c
|
||||
gets all edges of the cell `c`
|
||||
*/
|
||||
Cell_edges cell_edges(const Cell_descriptor& c) const;
|
||||
|
||||
/*!
|
||||
iterates over all vertices and call a functor on each one
|
||||
iterates over all vertices and calls the functor `f` on each one
|
||||
|
||||
\tparam ConcurrencyTag decides if the vertices are iterated sequentially or in parallel.
|
||||
Can be either `CGAL::Sequential_tag`, `CGAL::Parallel_if_available_tag`, or `CGAL::Parallel_tag`.
|
||||
|
|
@ -134,7 +134,7 @@ public:
|
|||
void iterate_vertices(Functor& f) const;
|
||||
|
||||
/*!
|
||||
iterates over all edges and call a functor f on each one
|
||||
iterates over all edges and calls the functor `f` on each one
|
||||
|
||||
\tparam ConcurrencyTag decides if the edges are iterated sequentially or in parallel.
|
||||
Can be either `CGAL::Sequential_tag`, `CGAL::Parallel_if_available_tag`, or `CGAL::Parallel_tag`.
|
||||
|
|
@ -145,7 +145,7 @@ public:
|
|||
void iterate_edges(Functor& f) const;
|
||||
|
||||
/*!
|
||||
iterates over all cells and call a functor f on each one
|
||||
iterates over all cells and calls the functor `f` on each one
|
||||
|
||||
\tparam ConcurrencyTag decides if the cells are iterated sequentially or in parallel.
|
||||
Can be either `CGAL::Sequential_tag`, `CGAL::Parallel_if_available_tag`, or `CGAL::Parallel_tag`.
|
||||
|
|
|
|||
|
|
@ -76,7 +76,7 @@ public:
|
|||
|
||||
`Point_3 operator()(FT x, FT y, FT z)`
|
||||
|
||||
which constructs a 3D point from a set of coordinates.
|
||||
which constructs a 3D point from its three coordinates.
|
||||
*/
|
||||
typedef unspecified_type Construct_point_3;
|
||||
|
||||
|
|
@ -85,7 +85,7 @@ public:
|
|||
|
||||
`Vector_3 operator()(FT x, FT y, FT z)`
|
||||
|
||||
which constructs a 3D vector from a set of coordinates.
|
||||
which constructs a 3D vector from its three coordinates.
|
||||
*/
|
||||
typedef unspecified_type Construct_vector_3;
|
||||
|
||||
|
|
|
|||
|
|
@ -69,7 +69,7 @@ using Explicit_Cartesian_grid_domain_3 =
|
|||
* \param grid the %Cartesian grid containing input data
|
||||
* \param grad a function that describes the gradient of the data
|
||||
*
|
||||
* \return a new `Explicit_Cartesian_grid_domain_3`
|
||||
* \return a new `CGAL::Explicit_Cartesian_grid_domain_3`
|
||||
*/
|
||||
#ifdef DOXYGEN_RUNNING // Allow more than Cartesian_grid_3
|
||||
template <typename GeomTraits,
|
||||
|
|
|
|||
|
|
@ -37,6 +37,9 @@ class Explicit_Cartesian_grid_gradient_3
|
|||
#endif
|
||||
{
|
||||
public:
|
||||
#ifdef DOXYGEN_RUNNING
|
||||
using Grid = Cartesian_grid_3<GeomTraits>;
|
||||
#endif
|
||||
using Geom_traits = typename Grid::Geom_traits;
|
||||
using FT = typename Geom_traits::FT;
|
||||
using Point_3 = typename Geom_traits::Point_3;
|
||||
|
|
|
|||
|
|
@ -82,7 +82,7 @@ using Implicit_Cartesian_grid_domain_3 =
|
|||
* \param grad a function that describes the gradient of the data
|
||||
* \param gt an instance of geometric traits
|
||||
*
|
||||
* \return a new `Implicit_Cartesian_grid_domain_3`
|
||||
* \return a new `CGAL::Implicit_Cartesian_grid_domain_3`
|
||||
*/
|
||||
template <typename GeomTraits,
|
||||
typename ImplicitFunction,
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ using Implicit_octree_domain =
|
|||
* \param point_function the function with a point as argument
|
||||
* \param gradient a function that describes the gradient of the data
|
||||
*
|
||||
* \return a new `Implicit_octree_domain`
|
||||
* \return a new `CGAL::Implicit_octree_domain`
|
||||
*/
|
||||
#ifdef DOXYGEN_RUNNING // Allow more than the Octree_wrapper
|
||||
template <typename GeomTraits,
|
||||
|
|
|
|||
Loading…
Reference in New Issue