Subject: [Boost-commit] svn:boost r68548 - trunk/boost/spirit/home/support/iterators
From: blelbach_at_[hidden]
Date: 2011-01-29 13:57:05
Author: wash
Date: 2011-01-29 13:57:04 EST (Sat, 29 Jan 2011)
New Revision: 68548
URL: http://svn.boost.org/trac/boost/changeset/68548
Log:
Changed commented qbk markup for line_pos_iterator (regenned docs already committed).
Text files modified:
trunk/boost/spirit/home/support/iterators/line_pos_iterator.hpp | 67 ++++++++++++++++++---------------------
1 files changed, 31 insertions(+), 36 deletions(-)
Modified: trunk/boost/spirit/home/support/iterators/line_pos_iterator.hpp
==============================================================================
--- trunk/boost/spirit/home/support/iterators/line_pos_iterator.hpp (original)
+++ trunk/boost/spirit/home/support/iterators/line_pos_iterator.hpp 2011-01-29 13:57:04 EST (Sat, 29 Jan 2011)
@@ -14,17 +14,13 @@
namespace boost { namespace spirit
{
-
- ////////////////////////////////////////////////////////////////////////////
- // line_pos_iterator: a lightweight line position iterator. This iterator
- // adapter only stores the current line number, nothing else. Unlike spirit
- // classic's position_iterator, it does not store the column number and does
- // not need an end iterator. The current column can be computed, if needed.
- // Some line oriented utilities are provided including computation of the
- // current column.
- ////////////////////////////////////////////////////////////////////////////
-
- //[line_pos_iterator
+ //[line_pos_iterator_class
+ /*`The `line_pos_iterator` is a lightweight line position iterator.
+ This iterator adapter only stores the current line number, nothing else.
+ Unlike __classic__'s `position_iterator`, it does not store the
+ column number and does not need an end iterator. The current column can
+ be computed, if needed. */
+ //`[heading Class Reference]
template <class Iterator>
class line_pos_iterator : public boost::iterator_adaptor<
line_pos_iterator<Iterator> // Derived
@@ -40,12 +36,12 @@
std::size_t position() const;
private:
- friend class boost::iterator_core_access;
+ friend class boost::iterator_core_access;
- void increment();
+ void increment();
- std::size_t line; /*< The line position. >*/
- typename std::iterator_traits<Iterator>::value_type prev;
+ std::size_t line; // The line position.
+ typename std::iterator_traits<Iterator>::value_type prev;
};
//]
@@ -87,32 +83,31 @@
}
//[line_pos_iterator_utilities
+ //`[heading get_line]
template <class Iterator>
- inline std::size_t get_line(Iterator); /*< Get the line position. Returns -1
- if Iterator is not a
- line_pos_iterator. >*/
+ inline std::size_t get_line(Iterator);
+ /*`Get the line position. Returns -1 if Iterator is not a
+ `line_pos_iterator`. */
+ //`[heading get_line_start]
template <class Iterator>
- inline Iterator get_line_start(Iterator lower_bound,
- Iterator current); /*< Get an iterator to
- the beginning of the
- line. Applicable to any
- iterator. >*/
-
+ inline Iterator get_line_start(Iterator lower_bound, Iterator current);
+ /*`Get an iterator to the beginning of the line. Applicable to any
+ iterator. */
+
+ //`[heading get_current_line]
template <class Iterator>
inline iterator_range<Iterator>
- get_current_line(Iterator lower_bound,
- Iterator current,
- Iterator upper_bound); /*< Get the iterator range
- containing the current line.
- Applicable to any iterator. >*/
-
- template <class Iterator>
- inline std::size_t get_column(Iterator lower_bound,
- Iterator current,
- std::size_t tabs = 4); /*< Get the current
- column. Applicable to
- any iterator. >*/
+ get_current_line(Iterator lower_bound, Iterator current,
+ Iterator upper_bound);
+ /*`Get an `iterator_range` containing the current line. Applicable to any
+ iterator. */
+
+ //`[heading get_column]
+ template <class Iterator>
+ inline std::size_t get_column(Iterator lower_bound, Iterator current,
+ std::size_t tabs = 4);
+ /*`Get the current column. Applicable to any iterator. */
//]
template <class Iterator>