mirror of https://github.com/CGAL/cgal
Corrections on doc
This commit is contained in:
parent
937d4bfae9
commit
6b9055d3cb
|
|
@ -1,4 +1,4 @@
|
||||||
@INCLUDE = ${CGAL_DOC_PACKAGE_DEFAULTS}
|
@INCLUDE = ${CGAL_DOC_PACKAGE_DEFAULTS}
|
||||||
PROJECT_NAME = "CGAL ${CGAL_DOC_VERSION} - Put title of project here"
|
PROJECT_NAME = "CGAL ${CGAL_DOC_VERSION} - 3D Point Set"
|
||||||
INPUT = ${CMAKE_SOURCE_DIR}/Point_set_3/doc/Point_set_3/ \
|
INPUT = ${CMAKE_SOURCE_DIR}/Point_set_3/doc/Point_set_3/ \
|
||||||
${CMAKE_SOURCE_DIR}/Point_set_3/include
|
${CMAKE_SOURCE_DIR}/Point_set_3/include
|
||||||
|
|
|
||||||
|
|
@ -29,10 +29,7 @@
|
||||||
|
|
||||||
## Classes ##
|
## Classes ##
|
||||||
- `CGAL::Point_set_3<Gt>`
|
- `CGAL::Point_set_3<Gt>`
|
||||||
|
- `CGAL::Ply_interpreter_point_set_3<Gt>`
|
||||||
## Functions ##
|
|
||||||
|
|
||||||
- `CGAL::read_ply_point_set_3<Gt>`
|
|
||||||
|
|
||||||
|
|
||||||
*/
|
*/
|
||||||
|
|
|
||||||
|
|
@ -73,9 +73,6 @@ through iterators and property maps. The `CGAL::Point_set_3<Gt>`
|
||||||
structure directly provides these iterators and property maps so that
|
structure directly provides these iterators and property maps so that
|
||||||
applying \cgal algorithms to it is straightforward.
|
applying \cgal algorithms to it is straightforward.
|
||||||
|
|
||||||
|
|
||||||
\cgalExample{Point_set_3/point_set_algo.cpp}
|
|
||||||
|
|
||||||
\subsection Point_set_3_PSP Point Set Processing
|
\subsection Point_set_3_PSP Point Set Processing
|
||||||
|
|
||||||
When adding a new property to the point set, the associated property
|
When adding a new property to the point set, the associated property
|
||||||
|
|
@ -94,6 +91,9 @@ The following example shows how to apply some algorithms from the
|
||||||
|
|
||||||
- detecting the sphere shape with `CGAL::Shape_detection_3::Efficient_RANSAC`
|
- detecting the sphere shape with `CGAL::Shape_detection_3::Efficient_RANSAC`
|
||||||
|
|
||||||
|
\cgalExample{Point_set_3/point_set_algo.cpp}
|
||||||
|
|
||||||
|
|
||||||
\subsection Point_set_3_IO Input/Output
|
\subsection Point_set_3_IO Input/Output
|
||||||
|
|
||||||
Using functions of \cgal to read files requires a slightly different
|
Using functions of \cgal to read files requires a slightly different
|
||||||
|
|
|
||||||
|
|
@ -537,24 +537,6 @@ public:
|
||||||
return m_base.template get<T>(name);
|
return m_base.template get<T>(name);
|
||||||
}
|
}
|
||||||
|
|
||||||
/*!
|
|
||||||
\brief Gets the push property map of the given property.
|
|
||||||
|
|
||||||
\tparam T type of the property.
|
|
||||||
|
|
||||||
\param prop The property map.
|
|
||||||
|
|
||||||
\return Returns a pair containing: the wanted property map and a
|
|
||||||
boolean set to `true` or an empty property map and a boolean set
|
|
||||||
to `false` (if the property was not found).
|
|
||||||
*/
|
|
||||||
template <class T>
|
|
||||||
Push_pmap<Properties::Property_map<Item, T> >
|
|
||||||
push_pmap (Properties::Property_map<Item, T>& prop)
|
|
||||||
{
|
|
||||||
return Push_pmap<Properties::Property_map<Item, T> > (this, &prop, size());
|
|
||||||
}
|
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\brief Removes the wanted property.
|
\brief Removes the wanted property.
|
||||||
|
|
||||||
|
|
@ -614,6 +596,24 @@ public:
|
||||||
/// \name Property Maps and Inserters
|
/// \name Property Maps and Inserters
|
||||||
/// @{
|
/// @{
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\brief Gets the push property map of the given property.
|
||||||
|
|
||||||
|
\tparam T type of the property.
|
||||||
|
|
||||||
|
\param prop The property map.
|
||||||
|
|
||||||
|
\return Returns a pair containing: the wanted property map and a
|
||||||
|
boolean set to `true` or an empty property map and a boolean set
|
||||||
|
to `false` (if the property was not found).
|
||||||
|
*/
|
||||||
|
template <class T>
|
||||||
|
Push_pmap<Properties::Property_map<Item, T> >
|
||||||
|
push_pmap (Properties::Property_map<Item, T>& prop)
|
||||||
|
{
|
||||||
|
return Push_pmap<Properties::Property_map<Item, T> > (this, &prop, size());
|
||||||
|
}
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\brief Get the property map of the point attribute.
|
\brief Get the property map of the point attribute.
|
||||||
*/
|
*/
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue