mirror of https://github.com/CGAL/cgal
Document parameters() in CGAL::Point_set_3
This commit is contained in:
parent
86e37c9a34
commit
0e81f39e07
|
|
@ -1,2 +1,14 @@
|
|||
@INCLUDE = ${CGAL_DOC_PACKAGE_DEFAULTS}
|
||||
PROJECT_NAME = "CGAL ${CGAL_DOC_VERSION} - 3D Point Set"
|
||||
|
||||
# macros to be used inside the code
|
||||
ALIASES += "cgalNamedParamsBegin=<dl class=\"params\"><dt>Named Parameters</dt><dd> <table class=\"params\">"
|
||||
ALIASES += "cgalNamedParamsEnd=</table> </dd> </dl>"
|
||||
ALIASES += "cgalParamBegin{1}=<tr><td class=\"paramname\">\ref PSP_\1 \"\1\"</td><td>"
|
||||
ALIASES += "cgalParamEnd=</td></tr>"
|
||||
|
||||
#macros for NamedParameters.txt
|
||||
ALIASES += "cgalNPTableBegin=<dl class=\"params\"><dt></dt><dd> <table class=\"params\">"
|
||||
ALIASES += "cgalNPTableEnd=</table> </dd> </dl>"
|
||||
ALIASES += "cgalNPBegin{1}=<tr><td class=\"paramname\">\1 </td><td>"
|
||||
ALIASES += "cgalNPEnd=</td></tr>"
|
||||
|
|
|
|||
|
|
@ -837,6 +837,22 @@ public:
|
|||
return out;
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief Returns a sequence of \ref psp_namedparameters "Named Parameters" for Point Set Processing algorithms.
|
||||
|
||||
\cgalNamedParamsBegin
|
||||
\cgalParamBegin{point_map} contains the point map (see `point_map()`)\cgalParamEnd
|
||||
\cgalParamBegin{normal_map} contains the normal map (see `normal_map()`)\cgalParamEnd
|
||||
\cgalParamBegin{geom_traits} contains the kernel `typename Kernel_traits<Point>`::`Kernel`\cgalParamEnd
|
||||
\cgalNamedParamsEnd
|
||||
|
||||
\warning this method does not check if the normal map was
|
||||
instanciated or not. The normal map named parameter should not be
|
||||
used if this property was not instanciated first.
|
||||
*/
|
||||
#ifdef DOXYGEN_RUNNING
|
||||
unspecified_type
|
||||
#else
|
||||
cgal_bgl_named_params
|
||||
<typename Kernel_traits<Point>::Kernel,
|
||||
internal_np::geom_traits_t,
|
||||
|
|
@ -846,6 +862,7 @@ public:
|
|||
cgal_bgl_named_params
|
||||
<typename CGAL::Point_set_3<Point, Vector>::template Property_map<Point>,
|
||||
internal_np::point_t> > >
|
||||
#endif
|
||||
inline parameters() const
|
||||
{
|
||||
return CGAL::parameters::point_map (m_points).
|
||||
|
|
@ -1160,7 +1177,7 @@ Point_set_3<Point, Vector>& operator+=(Point_set_3<Point, Vector>& ps,
|
|||
|
||||
|
||||
|
||||
|
||||
/// \cond SKIP_IN_MANUAL
|
||||
namespace Point_set_processing_3
|
||||
{
|
||||
namespace parameters
|
||||
|
|
@ -1181,7 +1198,7 @@ namespace Point_set_processing_3
|
|||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// \endcond
|
||||
|
||||
} // namespace CGAL
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue