diff --git a/doc/quickbook/adaptor.qbk b/doc/quickbook/adaptor.qbk index cdef018..d791ce0 100644 --- a/doc/quickbook/adaptor.qbk +++ b/doc/quickbook/adaptor.qbk @@ -132,7 +132,7 @@ above are defined as follows: iterator_adaptor(); -[*Requires:] The `Base` type must be Default Constructible.\n +[*Requires:] The `Base` type must be Default Constructible.[br] [*Returns:] An instance of `iterator_adaptor` with `m_iterator` default constructed. @@ -206,7 +206,7 @@ we're going to pick up right where it left off. .. |fac_tut| replace:: `iterator_facade` tutorial .. _fac_tut: iterator_facade.html#tutorial-example -[blurb [*`node_base*` really *is* an iterator]\n\n +[blurb [*`node_base*` really *is* an iterator][br][br] It's not really a very interesting iterator, since `node_base` is an abstract class: a pointer to a `node_base` just points at some base subobject of an instance of some other class, and diff --git a/doc/quickbook/concepts.qbk b/doc/quickbook/concepts.qbk index 13d429b..679d1a8 100644 --- a/doc/quickbook/concepts.qbk +++ b/doc/quickbook/concepts.qbk @@ -156,7 +156,7 @@ semantics. [ [`++r`] [`X&`] - [pre:\n`r` is dereferenceable;\npost:\n`r` is dereferenceable or\n`r` is past-the-end] + [pre:[br]`r` is dereferenceable;[br]post:[br]`r` is dereferenceable or[br]`r` is past-the-end] ] [ [`a == b`] @@ -227,7 +227,7 @@ the stated semantics. [ [`--r`] [`X&`] - [pre: there exists `s` such that `r == ++s`.\n post: `s` is dereferenceable. `--(++r) == r`. `--r == --s` implies `r == s`. `&r == &--r`.] + [pre: there exists `s` such that `r == ++s`.[br] post: `s` is dereferenceable. `--(++r) == r`. `--r == --s` implies `r == s`. `&r == &--r`.] ] [ [`r--`] diff --git a/doc/quickbook/counting_iterator.qbk b/doc/quickbook/counting_iterator.qbk index fad4904..c33d065 100644 --- a/doc/quickbook/counting_iterator.qbk +++ b/doc/quickbook/counting_iterator.qbk @@ -152,7 +152,7 @@ operations. counting_iterator(); -[*Requires: ] `Incrementable` is Default Constructible.\n +[*Requires: ] `Incrementable` is Default Constructible.[br] [*Effects: ] Default construct the member `m_inc`. @@ -174,13 +174,13 @@ operations. counting_iterator& operator++(); -[*Effects: ] `++m_inc`\n +[*Effects: ] `++m_inc`[br] [*Returns: ] `*this` counting_iterator& operator--(); -[*Effects: ] `--m_inc`\n +[*Effects: ] `--m_inc`[br] [*Returns: ] `*this` diff --git a/doc/quickbook/facade.qbk b/doc/quickbook/facade.qbk index ed62e47..ac7104f 100644 --- a/doc/quickbook/facade.qbk +++ b/doc/quickbook/facade.qbk @@ -68,6 +68,7 @@ requirements. [ [`i.dereference()`] [Access the value referred to] + ] [ [`i.equal(j)`] [Compare for equality with `j`] @@ -83,6 +84,7 @@ requirements. [ [`i.advance(n)`] [Advance by `n` positions] + ] [ [`i.distance_to(j)`] [Measure the distance to `j`] @@ -487,7 +489,8 @@ w.m)` for some temporary object `w` of type `value_type`. iterator_facade const& rhs); [*Returns:] - + +[pre if `is_convertible::value` then @@ -495,6 +498,7 @@ w.m)` for some temporary object `w` of type `value_type`. Otherwise, `((Dr2 const&)rhs).equal((Dr1 const&)lhs)`. +] template ::value` then @@ -512,6 +517,7 @@ w.m)` for some temporary object `w` of type `value_type`. Otherwise, `!((Dr2 const&)rhs).equal((Dr1 const&)lhs)`. +] template ::value` then @@ -529,6 +536,7 @@ w.m)` for some temporary object `w` of type `value_type`. Otherwise, `((Dr2 const&)rhs).distance_to((Dr1 const&)lhs) > 0`. +] template ::value` then @@ -546,6 +555,7 @@ w.m)` for some temporary object `w` of type `value_type`. Otherwise, `((Dr2 const&)rhs).distance_to((Dr1 const&)lhs) >= 0`. +] template ::value` then @@ -563,6 +574,7 @@ w.m)` for some temporary object `w` of type `value_type`. Otherwise, `((Dr2 const&)rhs).distance_to((Dr1 const&)lhs) < 0`. +] template ::value` then @@ -580,6 +593,7 @@ w.m)` for some temporary object `w` of type `value_type`. Otherwise, `((Dr2 const&)rhs).distance_to((Dr1 const&)lhs) <= 0`. +] .. _minus: @@ -592,6 +606,7 @@ w.m)` for some temporary object `w` of type `value_type`. [*Return Type:] +[pre if `is_convertible::value` then @@ -600,9 +615,11 @@ w.m)` for some temporary object `w` of type `value_type`. Otherwise `difference` shall be `iterator_traits::difference_type` +] [*Returns:] +[pre if `is_convertible::value` then @@ -610,6 +627,7 @@ w.m)` for some temporary object `w` of type `value_type`. Otherwise, `((Dr2 const&)rhs).distance_to((Dr1 const&)lhs)`. +] [endsect] diff --git a/doc/quickbook/facade_tutorial.qbk b/doc/quickbook/facade_tutorial.qbk index 09682ac..756c11e 100644 --- a/doc/quickbook/facade_tutorial.qbk +++ b/doc/quickbook/facade_tutorial.qbk @@ -261,17 +261,17 @@ __ ../example/node_iterator1.cpp [h2 A constant `node_iterator`] -[blurb *Constant and Mutable iterators*\n\n +[blurb *Constant and Mutable iterators*[br][br] The term **mutable iterator** means an iterator through which the object it references (its "referent") can be modified. A **constant iterator** is one which doesn't allow modification of -its referent.\n\n +its referent.[br][br] The words *constant* and *mutable* don't refer to the ability to modify the iterator itself. For example, an `int const*` is a non-\ `const` *constant iterator*, which can be incremented but doesn't allow modification of its referent, and `int* const` is a `const` *mutable iterator*, which cannot be -modified but which allows modification of its referent.\n\n +modified but which allows modification of its referent.[br][br] Confusing? We agree, but those are the standard terms. It probably doesn't help much that a container's constant iterator is called `const_iterator`. @@ -312,7 +312,7 @@ changes: node_base **const**\ * m_node; }; -[blurb `const` and an iterator's `value_type`\n\n +[blurb `const` and an iterator's `value_type`[br][br] The C++ standard requires an iterator's `value_type` *not* be `const`\ -qualified, so `iterator_facade` strips the `const` from its `Value` parameter in order to produce the diff --git a/doc/quickbook/filter_iterator.qbk b/doc/quickbook/filter_iterator.qbk index 5a46000..5076353 100644 --- a/doc/quickbook/filter_iterator.qbk +++ b/doc/quickbook/filter_iterator.qbk @@ -178,7 +178,7 @@ operations. filter_iterator(); -[*Requires: ]`Predicate` and `Iterator` must be Default Constructible.\n +[*Requires: ]`Predicate` and `Iterator` must be Default Constructible.[br] [*Effects: ] Constructs a `filter_iterator` whose`m_pred`, `m_iter`, and `m_end` members are a default constructed. @@ -195,7 +195,7 @@ operations. filter_iterator(Iterator x, Iterator end = Iterator()); [*Requires: ] `Predicate` must be Default Constructible and - `Predicate` is a class type (not a function pointer).\n + `Predicate` is a class type (not a function pointer).[br] [*Effects: ] Constructs a `filter_iterator` where `m_iter` is either the first position in the range `[x,end)` such that `m_pred(*m_iter) == true` or else`m_iter == end`. The member `m_pred` is default constructed. @@ -205,9 +205,9 @@ operations. filter_iterator( filter_iterator const& t , typename enable_if_convertible::type* = 0 // exposition - );` + ); -[*Requires: ] `OtherIterator` is implicitly convertible to `Iterator`.\n +[*Requires: ] `OtherIterator` is implicitly convertible to `Iterator`.[br] [*Effects: ] Constructs a filter iterator whose members are copied from `t`. @@ -235,7 +235,7 @@ operations. [*Effects: ] Increments `m_iter` and then continues to increment `m_iter` until either `m_iter == m_end` - or `m_pred(*m_iter) == true`.\n + or `m_pred(*m_iter) == true`.[br] [*Returns: ] `*this` diff --git a/doc/quickbook/indirect_iterator.qbk b/doc/quickbook/indirect_iterator.qbk index af53d86..2556aa2 100644 --- a/doc/quickbook/indirect_iterator.qbk +++ b/doc/quickbook/indirect_iterator.qbk @@ -203,7 +203,7 @@ following operations: indirect_iterator(); -[*Requires: ] `Iterator` must be Default Constructible.\n +[*Requires: ] `Iterator` must be Default Constructible.[br] [*Effects: ] Constructs an instance of `indirect_iterator` with a default-constructed `m_iterator`. @@ -225,7 +225,7 @@ following operations: , typename enable_if_convertible::type* = 0 // exposition ); -[*Requires: ] `Iterator2` is implicitly convertible to `Iterator`.\n +[*Requires: ] `Iterator2` is implicitly convertible to `Iterator`.[br] [*Effects: ] Constructs an instance of `indirect_iterator` whose `m_iterator` subobject is constructed from `y.base()`. @@ -242,13 +242,13 @@ following operations: indirect_iterator& operator++(); -[*Effects: ] `++m_iterator`\n +[*Effects: ] `++m_iterator`[br] [*Returns: ] `*this` indirect_iterator& operator--(); -[*Effects: ] `--m_iterator`\n +[*Effects: ] `--m_iterator`[br] [*Returns: ] `*this` [endsect] \ No newline at end of file diff --git a/doc/quickbook/iterator.qbk b/doc/quickbook/iterator.qbk index 9c7c4b7..0ec20b2 100644 --- a/doc/quickbook/iterator.qbk +++ b/doc/quickbook/iterator.qbk @@ -1,6 +1,7 @@ [library Boost.Iterator [/ version 1.0.1] + [quickbook 1.6] [authors [Abrahams, David], [Siek, Jeremy], [Witt, Thomas]] [copyright 2003 2005 David Abrahams Jeremy Siek Thomas Witt] [category iterator] @@ -99,7 +100,7 @@ adaptors`_ mentioned below have been proposed for standardization The iterator library supplies a useful suite of standard-conforming iterator templates based on the Boost [link -intro.iterator_facade_and_adaptor iterator facade and adaptor] +iterator.intro.iterator_facade_and_adaptor iterator facade and adaptor] templates. [def _counting_ [@./counting_iterator.html `counting_iterator`]] diff --git a/doc/quickbook/permutation_iterator.qbk b/doc/quickbook/permutation_iterator.qbk index 718a368..81352b6 100644 --- a/doc/quickbook/permutation_iterator.qbk +++ b/doc/quickbook/permutation_iterator.qbk @@ -189,7 +189,7 @@ following operations. permutation_iterator& operator++(); -[*Effects: ] `++m_order`\n +[*Effects: ] `++m_order`[br] [*Returns: ] `*this` diff --git a/doc/quickbook/reverse_iterator.qbk b/doc/quickbook/reverse_iterator.qbk index c9973ca..2599105 100644 --- a/doc/quickbook/reverse_iterator.qbk +++ b/doc/quickbook/reverse_iterator.qbk @@ -115,7 +115,7 @@ operations. reverse_iterator(); -[*Requires: ] `Iterator` must be Default Constructible.\n +[*Requires: ] `Iterator` must be Default Constructible.[br] [*Effects: ] Constructs an instance of `reverse_iterator` with `m_iterator` default constructed. @@ -131,7 +131,7 @@ operations. , typename enable_if_convertible::type* = 0 // exposition ); -[*Requires: ] `OtherIterator` is implicitly convertible to `Iterator`.\n +[*Requires: ] `OtherIterator` is implicitly convertible to `Iterator`.[br] [*Effects: ] Constructs instance of `reverse_iterator` whose `m_iterator` subobject is constructed from `y.base()`. @@ -149,12 +149,12 @@ operations. reverse_iterator& operator++(); -[*Effects: ] `--m_iterator`\n +[*Effects: ] `--m_iterator`[br] [*Returns: ] `*this` reverse_iterator& operator--(); -[*Effects: ] `++m_iterator`\n +[*Effects: ] `++m_iterator`[br] [*Returns: ] `*this` [endsect] \ No newline at end of file diff --git a/doc/quickbook/transform_iterator.qbk b/doc/quickbook/transform_iterator.qbk index 04416a1..adf30b8 100644 --- a/doc/quickbook/transform_iterator.qbk +++ b/doc/quickbook/transform_iterator.qbk @@ -85,7 +85,7 @@ The source code for this example can be found If `Reference` is `use_default` then the `reference` member of -`transform_iterator` is\n +`transform_iterator` is[br] `result_of::reference)>::type`. Otherwise, `reference` is `Reference`. @@ -160,7 +160,7 @@ interoperable with `Y`. [h3 Operations] -In addition to the operations required by the [link transform.concepts concepts] modeled by +In addition to the operations required by the [link iterator.specialized.transform.concepts concepts] modeled by `transform_iterator`, `transform_iterator` provides the following operations: @@ -183,7 +183,7 @@ operations: [*Returns: ] An instance of `transform_iterator` with `m_f` initialized to `t.functor()` and `m_iterator` initialized to - `t.base()`.\n + `t.base()`.[br] [*Requires: ] `OtherIterator` is implicitly convertible to `Iterator`. @@ -204,13 +204,13 @@ operations: transform_iterator& operator++(); -[*Effects: ] `++m_iterator`\n +[*Effects: ] `++m_iterator`[br] [*Returns: ] `*this` transform_iterator& operator--(); -[*Effects: ] `--m_iterator`\n +[*Effects: ] `--m_iterator`[br] [*Returns: ] `*this` [endsect] diff --git a/doc/quickbook/utilities.qbk b/doc/quickbook/utilities.qbk index 3e001a2..d219842 100644 --- a/doc/quickbook/utilities.qbk +++ b/doc/quickbook/utilities.qbk @@ -49,7 +49,7 @@ proxy references or return the pointee by value. When that information is needed, call on `indirect_reference`. Both of these templates are essential to the correct functioning of -[link boost_iterator.indirect `indirect_iterator`]. +[link iterator.specialized.indirect `indirect_iterator`]. [h2 `minimum_category`] @@ -103,9 +103,9 @@ or not), these additional tags are not considered. if ( ++x is ill-formed ) { - return `Dereferenceable::element_type` + return Dereferenceable::element_type } - else if (`*x` is a mutable reference to + else if (*x is a mutable reference to std::iterator_traits::value_type) { return iterator_traits::value_type @@ -135,7 +135,7 @@ or not), these additional tags are not considered. `x` is an object of type `Dereferenceable`: if ( ++x is ill-formed ) - return `pointee::type&` + return pointee::type& else std::iterator_traits::reference diff --git a/doc/quickbook/zip_iterator.qbk b/doc/quickbook/zip_iterator.qbk index ccd8689..6395538 100644 --- a/doc/quickbook/zip_iterator.qbk +++ b/doc/quickbook/zip_iterator.qbk @@ -228,7 +228,7 @@ operations. , IteratorTuple>::type* = 0 // exposition only ); -[*Returns:] An instance of `zip_iterator` that is a copy of `other`.\n +[*Returns:] An instance of `zip_iterator` that is a copy of `other`.[br] [*Requires:] `OtherIteratorTuple` is implicitly convertible to `IteratorTuple`. @@ -245,13 +245,13 @@ operations. zip_iterator& operator++(); -[*Effects:] Increments each iterator in `m_iterator_tuple`.\n +[*Effects:] Increments each iterator in `m_iterator_tuple`.[br] [*Returns:] `*this` zip_iterator& operator--(); -[*Effects:] Decrements each iterator in `m_iterator_tuple`.\n +[*Effects:] Decrements each iterator in `m_iterator_tuple`.[br] [*Returns:] `*this` template