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

STL_extension: doc improvements 

Add `()` to functions.   Backtick.
This commit is contained in:
Andreas Fabri 2022-09-27 10:57:18 +02:00 committed by GitHub
parent 9a3ca6e948
commit f411e0902c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
STL_Extension/doc/STL_Extension/CGAL/algorithm.h
View File

@ -7,7 +7,7 @@ namespace CGAL {
/*! /*!
\ingroup STLAlgos \ingroup STLAlgos
\deprecated This function is deprecated, std::copy_n should be \deprecated This function is deprecated, `std::copy_n()` should be
used instead. used instead.
Copies the first `n` items from `first` to `result`. Copies the first `n` items from `first` to `result`.
@ -36,15 +36,15 @@ namespace CGAL {
Computes the minimal and the Computes the minimal and the
maximal element of a range. It is modeled after the STL functions maximal element of a range. It is modeled after the STL functions
`std::min_element` and `std::max_element`. The advantage of `std::min_element()` and `std::max_element()`. The advantage of
`min_max_element` compared to calling both STL functions is that `min_max_element()` compared to calling both STL functions is that
one only iterates once over the sequence. This is more efficient one only iterates once over the sequence. This is more efficient
especially for large and/or complex sequences. especially for large and/or complex sequences.
\cgalHeading{Example} \cgalHeading{Example}
The following example program computes the minimal and The following example program computes the minimal and
maximal element of the sequence ` (3,\,6,\,5)`. Hence the output is maximal element of the sequence `(3,\,6,\,5)`. Hence the output is
`min = 3, max = 6`. `min = 3, max = 6`.
\cgalExample{STL_Extension/min_max_element_example.cpp} \cgalExample{STL_Extension/min_max_element_example.cpp}
@ -65,8 +65,8 @@ first, ForwardIterator last);
Computes the minimal and the Computes the minimal and the
maximal element of a range. It is modeled after the STL functions maximal element of a range. It is modeled after the STL functions
`std::min_element` and `std::max_element`. The advantage of `std::min_element()` and `std::max_element()`. The advantage of
`min_max_element` compared to calling both STL functions is that `min_max_element()` compared to calling both STL functions is that
one only iterates once over the sequence. This is more efficient one only iterates once over the sequence. This is more efficient
especially for large and/or complex sequences. especially for large and/or complex sequences.
@ -95,11 +95,11 @@ namespace CGAL {
/*! /*!
\ingroup STLAlgos \ingroup STLAlgos
\deprecated This function is deprecated. `std::prev` should be used \deprecated This function is deprecated. `std::prev()` should be used
instead. instead.
Returns the previous iterator, Returns the previous iterator,
i.e.\ the result of `operator--` on a bidirectional iterator. i.e.\ the result of `operator--()` on a bidirectional iterator.
\sa `CGAL::successor()` \sa `CGAL::successor()`
@ -115,17 +115,17 @@ namespace CGAL {
/*! /*!
\ingroup STLAlgos \ingroup STLAlgos
\deprecated This function is deprecated. `std::next` should be used \deprecated This function is deprecated. `std::next()` should be used
instead. instead.
Returns the next iterator, i.e. Returns the next iterator, i.e.,
the result of `operator++` on a forward iterator. the result of `operator++()` on a forward iterator.
\sa `CGAL::predecessor()` \sa `CGAL::predecessor()`
\returns `++it`. \returns `it`.
*/ */
template <class ForwardIterator> template <class ForwardIterator>
ForwardIterator successor(ForwardIterator it); ForwardIterator successor(ForwardIterator it);