songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update Reference Manual with additional template parameter

This commit is contained in:
Simon Giraudot 2015-09-08 12:38:34 +02:00
parent 8be703a0c8
commit 2c6e6e5e57
5 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Point_set_processing_3/include/CGAL/compute_average_spacing.h
View File

@ -130,6 +130,9 @@ compute_average_spacing(const typename Kernel::Point_3& query, ///< 3D point who
/// ///
/// \pre `k >= 2.` /// \pre `k >= 2.`
/// ///
/// @tparam Concurrency_tag enables sequential versus parallel algorithm.
/// Possible values are `Sequential_tag`
/// and `Parallel_tag`.
/// @tparam InputIterator iterator over input points. /// @tparam InputIterator iterator over input points.
/// @tparam PointPMap is a model of `ReadablePropertyMap` with value type `Point_3<Kernel>`. /// @tparam PointPMap is a model of `ReadablePropertyMap` with value type `Point_3<Kernel>`.
/// It can be omitted if the value type of `InputIterator` is convertible to `Point_3<Kernel>`. /// It can be omitted if the value type of `InputIterator` is convertible to `Point_3<Kernel>`.

4
Point_set_processing_3/include/CGAL/edge_aware_upsample_point_set.h
View File

@ -285,6 +285,10 @@ update_new_point(
/// in point-based rendering, hole filling, and sparse surface reconstruction. /// in point-based rendering, hole filling, and sparse surface reconstruction.
/// Normals of points are required as input. For more details, please refer to \cgalCite{ear-2013}. /// Normals of points are required as input. For more details, please refer to \cgalCite{ear-2013}.
/// ///
/// @tparam Concurrency_tag enables sequential versus parallel
/// versions of `compute_average_spacing()` (called internally).
/// Possible values are `Sequential_tag`
/// and `Parallel_tag`.
/// @tparam OutputIterator Type of the output iterator. /// @tparam OutputIterator Type of the output iterator.
/// The type of the objects put in it is /// The type of the objects put in it is
/// `std::pair<Kernel::Point_3, Kernel::Vector_3>`. /// `std::pair<Kernel::Point_3, Kernel::Vector_3>`.

4
Point_set_processing_3/include/CGAL/jet_estimate_normals.h
View File

@ -151,7 +151,9 @@ jet_estimate_normal(const typename Kernel::Point_3& query, ///< point to compute
/// ///
/// \pre `k >= 2` /// \pre `k >= 2`
/// ///
/// /// @tparam Concurrency_tag enables sequential versus parallel algorithm.
/// Possible values are `Sequential_tag`
/// and `Parallel_tag`.
/// @tparam ForwardIterator iterator model of the concept of the same name over input points and able to store output normals. /// @tparam ForwardIterator iterator model of the concept of the same name over input points and able to store output normals.
/// @tparam PointPMap is a model of `ReadablePropertyMap` with value type `Point_3<Kernel>`. /// @tparam PointPMap is a model of `ReadablePropertyMap` with value type `Point_3<Kernel>`.
/// It can be omitted if the value type of `ForwardIterator` is convertible to `Point_3<Kernel>`. /// It can be omitted if the value type of `ForwardIterator` is convertible to `Point_3<Kernel>`.

3
Point_set_processing_3/include/CGAL/jet_smooth_point_set.h
View File

@ -155,6 +155,9 @@ jet_smooth_point(
/// ///
/// \pre `k >= 2` /// \pre `k >= 2`
/// ///
/// @tparam Concurrency_tag enables sequential versus parallel algorithm.
/// Possible values are `Sequential_tag`
/// and `Parallel_tag`.
/// @tparam InputIterator iterator over input points. /// @tparam InputIterator iterator over input points.
/// @tparam PointPMap is a model of `ReadWritePropertyMap` with value type `Point_3<Kernel>`. /// @tparam PointPMap is a model of `ReadWritePropertyMap` with value type `Point_3<Kernel>`.
/// It can be omitted if the value type of `InputIterator` is convertible to `Point_3<Kernel>`. /// It can be omitted if the value type of `InputIterator` is convertible to `Point_3<Kernel>`.

3
Point_set_processing_3/include/CGAL/pca_estimate_normals.h
View File

@ -142,6 +142,9 @@ pca_estimate_normal(const typename Kernel::Point_3& query, ///< point to compute
/// ///
/// \pre `k >= 2` /// \pre `k >= 2`
/// ///
/// @tparam Concurrency_tag enables sequential versus parallel algorithm.
/// Possible values are `Sequential_tag`
/// and `Parallel_tag`.
/// @tparam ForwardIterator iterator over input points. /// @tparam ForwardIterator iterator over input points.
/// @tparam PointPMap is a model of `ReadablePropertyMap` with value type `Point_3<Kernel>`. /// @tparam PointPMap is a model of `ReadablePropertyMap` with value type `Point_3<Kernel>`.
/// It can be omitted if the value type of `ForwardIterator` is convertible to `Point_3<Kernel>`. /// It can be omitted if the value type of `ForwardIterator` is convertible to `Point_3<Kernel>`.