From e3e1fc43d3977db68ab90831ea8e61a20a1bad2c Mon Sep 17 00:00:00 2001
From: Neil Groves
Date: Wed, 28 Apr 2010 18:03:26 +0000
Subject: [PATCH] Boost.Range documentation iteration. Primarily this is the
inclusion of Range Return Categories for every Range Adaptor page.
[SVN r61653]
---
doc/boost_range.qbk | 44 +-
doc/html/index.html | 13 +-
doc/html/quickbook_HTML.manifest | 10 +-
.../range/concepts/bidirectional_range.html | 23 +-
doc/html/range/concepts/concept_checking.html | 2 +-
doc/html/range/concepts/forward_range.html | 17 +-
.../range/concepts/random_access_range.html | 12 +-
.../range/concepts/single_pass_range.html | 23 +-
doc/html/range/history_ack.html | 4 +-
doc/html/range/library_headers/general.html | 30 +-
doc/html/range/mfc_atl.html | 4 +-
doc/html/range/portability.html | 10 +-
doc/html/range/reference.html | 9 +-
doc/html/range/reference/adaptors.html | 7 +-
.../adaptors_reference/adjacent_filtered.html | 151 -------
.../adaptors/adaptors_reference/copied.html | 152 -------
.../adaptors/adaptors_reference/filtered.html | 156 -------
.../adaptors/adaptors_reference/indexed.html | 186 --------
.../adaptors_reference/indirected.html | 146 -------
.../adaptors/adaptors_reference/map_keys.html | 146 -------
.../adaptors_reference/map_values.html | 146 -------
.../adaptors/adaptors_reference/replaced.html | 161 -------
.../adaptors_reference/replaced_if.html | 165 -------
.../adaptors/adaptors_reference/reversed.html | 140 ------
.../adaptors/adaptors_reference/sliced.html | 150 -------
.../adaptors/adaptors_reference/strided.html | 147 -------
.../adaptors_reference/tokenized.html | 143 ------
.../adaptors_reference/transformed.html | 156 -------
.../adaptors/adaptors_reference/uniqued.html | 142 ------
.../adaptors/general_requirements.html | 6 +-
.../reference/adaptors/introduction.html | 12 +-
.../adaptors/reference/adjacent_filtered.html | 8 +-
.../reference/adaptors/reference/copied.html | 7 +-
.../adaptors/reference/filtered.html | 8 +-
.../reference/adaptors/reference/indexed.html | 7 +-
.../adaptors/reference/indirected.html | 7 +-
.../adaptors/reference/map_keys.html | 7 +-
.../adaptors/reference/map_values.html | 7 +-
.../adaptors/reference/replaced.html | 7 +-
.../adaptors/reference/replaced_if.html | 7 +-
.../adaptors/reference/reversed.html | 7 +-
.../reference/adaptors/reference/sliced.html | 7 +-
.../reference/adaptors/reference/strided.html | 7 +-
.../adaptors/reference/tokenized.html | 7 +-
.../adaptors/reference/transformed.html | 7 +-
.../reference/adaptors/reference/uniqued.html | 8 +-
.../reference/algorithms/heap/make_heap.html | 10 +-
.../reference/algorithms/heap/pop_heap.html | 12 +-
.../reference/algorithms/heap/push_heap.html | 12 +-
.../reference/algorithms/heap/sort_heap.html | 12 +-
.../reference/algorithms/mutating/copy.html | 12 +-
.../algorithms/mutating/copy_backward.html | 12 +-
.../reference/algorithms/mutating/fill.html | 10 +-
.../reference/algorithms/mutating/fill_n.html | 10 +-
.../algorithms/mutating/generate.html | 12 +-
.../algorithms/mutating/inplace_merge.html | 16 +-
.../reference/algorithms/mutating/merge.html | 16 +-
.../algorithms/mutating/nth_element.html | 10 +-
.../algorithms/mutating/partial_sort.html | 10 +-
.../algorithms/mutating/partition.html | 10 +-
.../algorithms/mutating/random_shuffle.html | 12 +-
.../reference/algorithms/mutating/remove.html | 10 +-
.../algorithms/mutating/remove_copy.html | 10 +-
.../algorithms/mutating/remove_copy_if.html | 10 +-
.../algorithms/mutating/remove_if.html | 10 +-
.../algorithms/mutating/replace.html | 10 +-
.../algorithms/mutating/replace_copy.html | 10 +-
.../algorithms/mutating/replace_copy_if.html | 10 +-
.../algorithms/mutating/replace_if.html | 10 +-
.../algorithms/mutating/reverse.html | 10 +-
.../algorithms/mutating/reverse_copy.html | 10 +-
.../reference/algorithms/mutating/rotate.html | 12 +-
.../algorithms/mutating/rotate_copy.html | 12 +-
.../reference/algorithms/mutating/sort.html | 10 +-
.../algorithms/mutating/stable_partition.html | 10 +-
.../algorithms/mutating/stable_sort.html | 10 +-
.../algorithms/mutating/swap_ranges.html | 10 +-
.../algorithms/mutating/transform.html | 12 +-
.../reference/algorithms/mutating/unique.html | 10 +-
.../algorithms/mutating/unique_copy.html | 10 +-
.../reference/algorithms/new/copy_n.html | 10 +-
.../range/reference/algorithms/new/erase.html | 10 +-
.../reference/algorithms/new/for_each.html | 10 +-
.../reference/algorithms/new/insert.html | 10 +-
.../range/reference/algorithms/new/iota.html | 10 +-
.../reference/algorithms/new/is_sorted.html | 10 +-
.../reference/algorithms/new/overwrite.html | 10 +-
.../reference/algorithms/new/push_back.html | 10 +-
.../reference/algorithms/new/push_front.html | 10 +-
.../algorithms/new/remove_erase.html | 10 +-
.../algorithms/new/remove_erase_if.html | 10 +-
.../non_mutating/adjacent_find.html | 10 +-
.../non_mutating/binary_search.html | 12 +-
.../algorithms/non_mutating/count.html | 10 +-
.../algorithms/non_mutating/count_if.html | 10 +-
.../algorithms/non_mutating/equal.html | 10 +-
.../algorithms/non_mutating/equal_range.html | 12 +-
.../algorithms/non_mutating/find.html | 10 +-
.../algorithms/non_mutating/find_end.html | 10 +-
.../non_mutating/find_first_of.html | 10 +-
.../algorithms/non_mutating/find_if.html | 12 +-
.../algorithms/non_mutating/for_each.html | 10 +-
.../non_mutating/lexicographical_compare.html | 10 +-
.../algorithms/non_mutating/lower_bound.html | 12 +-
.../algorithms/non_mutating/max_element.html | 10 +-
.../algorithms/non_mutating/min_element.html | 10 +-
.../algorithms/non_mutating/mismatch.html | 12 +-
.../algorithms/non_mutating/search.html | 10 +-
.../algorithms/non_mutating/search_n.html | 10 +-
.../algorithms/non_mutating/upper_bound.html | 12 +-
.../algorithms/numeric/accumulate.html | 14 +-
.../numeric/adjacent_difference.html | 16 +-
.../algorithms/numeric/inner_product.html | 16 +-
.../algorithms/numeric/partial_sum.html | 16 +-
.../permutation/next_permutation.html | 10 +-
.../permutation/prev_permutation.html | 10 +-
.../reference/algorithms/set/includes.html | 12 +-
.../algorithms/set/set_difference.html | 12 +-
.../algorithms/set/set_intersection.html | 12 +-
.../set/set_symmetric_difference.html | 12 +-
.../reference/algorithms/set/set_union.html | 12 +-
.../reference/concept_implementation.html | 48 +++
.../concept_implementation/overview.html | 68 +++
.../concept_implementation/semantics.html | 163 +++++++
.../semantics/functions.html | 408 ++++++++++++++++++
.../semantics/metafunctions.html | 236 ++++++++++
.../concept_implementation/synopsis.html | 185 ++++++++
doc/html/range/reference/overview.html | 68 ---
.../reference/ranges/counting_range.html | 8 +-
doc/html/range/reference/ranges/irange.html | 14 +-
.../range/reference/ranges/istream_range.html | 6 +-
doc/html/range/reference/semantics.html | 163 -------
.../reference/utilities/iterator_range.html | 6 +-
doc/html/range/reference/utilities/join.html | 4 +-
.../range/reference/utilities/sub_range.html | 2 +-
doc/html/range/upgrade/upgrade_from_1_34.html | 7 +-
doc/reference.qbk | 4 +
doc/reference/adaptors.qbk | 24 --
doc/reference/adaptors/adjacent_filtered.qbk | 3 +-
doc/reference/adaptors/copied.qbk | 3 +-
doc/reference/adaptors/filtered.qbk | 4 +-
doc/reference/adaptors/indexed.qbk | 3 +-
doc/reference/adaptors/indirected.qbk | 3 +-
doc/reference/adaptors/map_keys.qbk | 3 +-
doc/reference/adaptors/map_values.qbk | 3 +-
doc/reference/adaptors/replaced.qbk | 3 +-
doc/reference/adaptors/replaced_if.qbk | 3 +-
doc/reference/adaptors/reversed.qbk | 3 +-
doc/reference/adaptors/sliced.qbk | 3 +-
doc/reference/adaptors/strided.qbk | 3 +-
doc/reference/adaptors/tokenized.qbk | 3 +-
doc/reference/adaptors/transformed.qbk | 3 +-
doc/reference/adaptors/uniqued.qbk | 3 +-
doc/reference/algorithms.qbk | 2 +-
doc/reference/ranges/irange.qbk | 6 +-
155 files changed, 1788 insertions(+), 3127 deletions(-)
delete mode 100644 doc/html/range/reference/adaptors/adaptors_reference/adjacent_filtered.html
delete mode 100644 doc/html/range/reference/adaptors/adaptors_reference/copied.html
delete mode 100644 doc/html/range/reference/adaptors/adaptors_reference/filtered.html
delete mode 100644 doc/html/range/reference/adaptors/adaptors_reference/indexed.html
delete mode 100644 doc/html/range/reference/adaptors/adaptors_reference/indirected.html
delete mode 100644 doc/html/range/reference/adaptors/adaptors_reference/map_keys.html
delete mode 100644 doc/html/range/reference/adaptors/adaptors_reference/map_values.html
delete mode 100644 doc/html/range/reference/adaptors/adaptors_reference/replaced.html
delete mode 100644 doc/html/range/reference/adaptors/adaptors_reference/replaced_if.html
delete mode 100644 doc/html/range/reference/adaptors/adaptors_reference/reversed.html
delete mode 100644 doc/html/range/reference/adaptors/adaptors_reference/sliced.html
delete mode 100644 doc/html/range/reference/adaptors/adaptors_reference/strided.html
delete mode 100644 doc/html/range/reference/adaptors/adaptors_reference/tokenized.html
delete mode 100644 doc/html/range/reference/adaptors/adaptors_reference/transformed.html
delete mode 100644 doc/html/range/reference/adaptors/adaptors_reference/uniqued.html
create mode 100644 doc/html/range/reference/concept_implementation.html
create mode 100644 doc/html/range/reference/concept_implementation/overview.html
create mode 100644 doc/html/range/reference/concept_implementation/semantics.html
create mode 100644 doc/html/range/reference/concept_implementation/semantics/functions.html
create mode 100644 doc/html/range/reference/concept_implementation/semantics/metafunctions.html
create mode 100644 doc/html/range/reference/concept_implementation/synopsis.html
delete mode 100644 doc/html/range/reference/overview.html
delete mode 100644 doc/html/range/reference/semantics.html
diff --git a/doc/boost_range.qbk b/doc/boost_range.qbk
index 6f6af4f..80bbf06 100644
--- a/doc/boost_range.qbk
+++ b/doc/boost_range.qbk
@@ -36,30 +36,30 @@
[def __iterator_range__ [link range.reference.utilities.iterator_range `iterator_range`]]
[def __sub_range__ [link range.reference.utilities.sub_range `sub_range`]]
[def __minimal_interface__ [link range.reference.extending minimal interface]]
-[def __range_result_iterator__ [link range.reference.semantics.metafunctions `range_result_iterator`]]
+[def __range_result_iterator__ [link range.reference.concept_implementation.semantics.metafunctions `range_result_iterator`]]
[def __extending_for_udts__ [link range.reference.extending Extending the library for UDTs]]
-[def __implementation_of_metafunctions__ [link range.reference.semantics.metafunctions Implementation of metafunctions]]
-[def __implementation_of_functions__ [link range.reference.semantics.functions Implementation of functions]]
+[def __implementation_of_metafunctions__ [link range.reference.concept_implementation.semantics.metafunctions Implementation of metafunctions]]
+[def __implementation_of_functions__ [link range.reference.concept_implementation.semantics.functions Implementation of functions]]
-[def __range_value__ [link range.reference.semantics.metafunctions `range_value`]]
-[def __range_iterator__ [link range.reference.semantics.metafunctions `range_iterator`]]
-[def __range_difference__ [link range.reference.semantics.metafunctions `range_difference`]]
-[def __range_pointer__ [link range.reference.semantics.metafunctions `range_pointer`]]
-[def __range_category__ [link range.reference.semantics.metafunctions `range_category`]]
-[def __range_reverse_iterator__ [link range.reference.semantics.metafunctions `range_reverse_iterator`]]
-[def __begin__ [link range.reference.semantics.functions `begin`]]
-[def __const_begin__ [link range.reference.semantics.functions `const_begin`]]
-[def __end__ [link range.reference.semantics.functions `end`]]
-[def __const_end__ [link range.reference.semantics.functions `const_end`]]
-[def __empty__ [link range.reference.semantics.functions `empty`]]
-[def __distance__ [link range.reference.semantics.functions `distance`]]
-[def __size__ [link range.reference.semantics.functions `size`]]
-[def __rbegin__ [link range.reference.semantics.functions `rbegin`]]
-[def __const_rbegin__ [link range.reference.semantics.functions `const_rbegin`]]
-[def __rend__ [link range.reference.semantics.functions `rend`]]
-[def __const_rend__ [link range.reference.semantics.functions `const_rend`]]
-[def __as_array__ [link range.reference.semantics.functions `as_array`]]
-[def __as_literal__ [link range.reference.semantics.functions `as_literal`]]
+[def __range_value__ [link range.reference.concept_implementation.semantics.metafunctions `range_value`]]
+[def __range_iterator__ [link range.reference.concept_implementation.semantics.metafunctions `range_iterator`]]
+[def __range_difference__ [link range.reference.concept_implementation.semantics.metafunctions `range_difference`]]
+[def __range_pointer__ [link range.reference.concept_implementation.semantics.metafunctions `range_pointer`]]
+[def __range_category__ [link range.reference.concept_implementation.semantics.metafunctions `range_category`]]
+[def __range_reverse_iterator__ [link range.reference.concept_implementation.semantics.metafunctions `range_reverse_iterator`]]
+[def __begin__ [link range.reference.concept_implementation.semantics.functions `begin`]]
+[def __const_begin__ [link range.reference.concept_implementation.semantics.functions `const_begin`]]
+[def __end__ [link range.reference.concept_implementation.semantics.functions `end`]]
+[def __const_end__ [link range.reference.concept_implementation.semantics.functions `const_end`]]
+[def __empty__ [link range.reference.concept_implementation.semantics.functions `empty`]]
+[def __distance__ [link range.reference.concept_implementation.semantics.functions `distance`]]
+[def __size__ [link range.reference.concept_implementation.semantics.functions `size`]]
+[def __rbegin__ [link range.reference.concept_implementation.semantics.functions `rbegin`]]
+[def __const_rbegin__ [link range.reference.concept_implementation.semantics.functions `const_rbegin`]]
+[def __rend__ [link range.reference.concept_implementation.semantics.functions `rend`]]
+[def __const_rend__ [link range.reference.concept_implementation.semantics.functions `const_rend`]]
+[def __as_array__ [link range.reference.concept_implementation.semantics.functions `as_array`]]
+[def __as_literal__ [link range.reference.concept_implementation.semantics.functions `as_literal`]]
[def __counting_range__ [link range.reference.ranges.counting_range `counting_range`]]
[def __irange__ [link range.reference.ranges.irange `irange`]]
[def __istream_range__ [link range.reference.ranges.istream_range `istream_range`]]
diff --git a/doc/html/index.html b/doc/html/index.html
index b2f6b77..f6095bd 100644
--- a/doc/html/index.html
+++ b/doc/html/index.html
@@ -30,7 +30,7 @@
Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves
-Last revised: April 28, 2010 at 15:53:14 GMT |
+Last revised: April 28, 2010 at 17:51:33 GMT |
|
diff --git a/doc/html/quickbook_HTML.manifest b/doc/html/quickbook_HTML.manifest
index 8a0d31a..7c5d13a 100644
--- a/doc/html/quickbook_HTML.manifest
+++ b/doc/html/quickbook_HTML.manifest
@@ -9,13 +9,13 @@ range/concepts/random_access_range.html
range/concepts/concept_checking.html
range/reference.html
range/reference/overview.html
-range/reference/synopsis.html
-range/reference/semantics.html
-range/reference/semantics/metafunctions.html
-range/reference/semantics/functions.html
+range/reference/concept_implementation.html
+range/reference/concept_implementation/synopsis.html
+range/reference/concept_implementation/semantics.html
+range/reference/concept_implementation/semantics/metafunctions.html
+range/reference/concept_implementation/semantics/functions.html
range/reference/adaptors.html
range/reference/adaptors/introduction.html
-range/reference/adaptors/adaptors_synopsis.html
range/reference/adaptors/general_requirements.html
range/reference/adaptors/reference.html
range/reference/adaptors/reference/adjacent_filtered.html
diff --git a/doc/html/range/concepts/bidirectional_range.html b/doc/html/range/concepts/bidirectional_range.html
index 1edda7b..72c8c28 100644
--- a/doc/html/range/concepts/bidirectional_range.html
+++ b/doc/html/range/concepts/bidirectional_range.html
@@ -27,7 +27,7 @@
Bidirectional Range
@@ -75,7 +75,7 @@
Traversal Iterator.
@@ -83,7 +83,7 @@
Forward Range
@@ -136,7 +136,7 @@
@@ -221,7 +221,7 @@
@@ -232,7 +232,7 @@
Forward Range.
- Implementation of
- metafunctions
+ Implementation
+ of metafunctions
- Implementation of functions
+ Implementation
+ of functions
diff --git a/doc/html/range/concepts/concept_checking.html b/doc/html/range/concepts/concept_checking.html
index 311794e..30d3850 100644
--- a/doc/html/range/concepts/concept_checking.html
+++ b/doc/html/range/concepts/concept_checking.html
@@ -79,7 +79,7 @@
diff --git a/doc/html/range/concepts/forward_range.html b/doc/html/range/concepts/forward_range.html
index 72df009..61ec9e8 100644
--- a/doc/html/range/concepts/forward_range.html
+++ b/doc/html/range/concepts/forward_range.html
@@ -27,7 +27,7 @@
Forward Range
@@ -73,14 +73,14 @@
Traversal Iterator.
Single Pass Range
@@ -132,15 +132,16 @@
- Implementation of
- metafunctions
+ Implementation
+ of metafunctions
- Implementation of functions
+ Implementation
+ of functions
diff --git a/doc/html/range/concepts/random_access_range.html b/doc/html/range/concepts/random_access_range.html
index 66edd3c..379410e 100644
--- a/doc/html/range/concepts/random_access_range.html
+++ b/doc/html/range/concepts/random_access_range.html
@@ -27,7 +27,7 @@
Random Access Range
@@ -35,7 +35,7 @@
Access Traversal Iterator.
@@ -43,7 +43,7 @@
Bidirectional Range
@@ -89,7 +89,7 @@
@@ -139,7 +139,7 @@
@@ -147,7 +147,7 @@
boost::size(a)
completes in amortized constant time.
@@ -198,7 +198,7 @@
@@ -266,7 +266,7 @@
@@ -276,7 +276,7 @@
constant time.
Extending the library for UDTs
- Implementation of
- metafunctions
+ Implementation
+ of metafunctions
- Implementation of functions
+ Implementation
+ of functions
Container
diff --git a/doc/html/range/history_ack.html b/doc/html/range/history_ack.html
index a67833d..37d497d 100644
--- a/doc/html/range/history_ack.html
+++ b/doc/html/range/history_ack.html
@@ -26,7 +26,7 @@
History and Acknowledgement
@@ -79,7 +79,7 @@
The concept checks and their documentation was provided by Daniel Walker.
diff --git a/doc/html/range/library_headers/general.html b/doc/html/range/library_headers/general.html
index 382215d..558fe74 100644
--- a/doc/html/range/library_headers/general.html
+++ b/doc/html/range/library_headers/general.html
@@ -111,7 +111,7 @@
- range_value
+ range_value
|
@@ -128,7 +128,7 @@
|
- range_iterator
+ range_iterator
|
@@ -145,7 +145,7 @@
|
- range_difference
+ range_difference
|
@@ -162,7 +162,7 @@
|
- range_pointer
+ range_pointer
|
@@ -179,7 +179,7 @@
|
- range_category
+ range_category
|
@@ -196,7 +196,7 @@
|
- range_reverse_iterator
+ range_reverse_iterator
|
@@ -214,7 +214,7 @@
|
- begin and const_begin
+ begin and const_begin
|
@@ -231,7 +231,7 @@
|
- end and const_end
+ end and const_end
|
@@ -248,7 +248,7 @@
|
- empty
+ empty
|
@@ -265,7 +265,7 @@
|
- distance
+ distance
|
@@ -282,7 +282,7 @@
|
- size
+ size
|
@@ -300,7 +300,7 @@
|
- rbegin and const_rbegin
+ rbegin and const_rbegin
|
@@ -318,7 +318,7 @@
|
- rend and const_rend
+ rend and const_rend
|
@@ -336,7 +336,7 @@
|
- as_array
+ as_array
|
@@ -353,7 +353,7 @@
|
- as_literal
+ as_literal
|
diff --git a/doc/html/range/mfc_atl.html b/doc/html/range/mfc_atl.html
index 1b4092d..c0f1c6d 100644
--- a/doc/html/range/mfc_atl.html
+++ b/doc/html/range/mfc_atl.html
@@ -34,7 +34,7 @@
References
@@ -100,7 +100,7 @@
diff --git a/doc/html/range/portability.html b/doc/html/range/portability.html
index 334df5a..45d3a07 100644
--- a/doc/html/range/portability.html
+++ b/doc/html/range/portability.html
@@ -38,7 +38,7 @@
Notice also that some compilers cannot do function template ordering properly.
- In that case one must rely of range_iterator and a single function
+ In that case one must rely of range_iterator and a single function
definition instead of overloaded versions for const and non-const arguments.
So if one cares about old compilers, one should not pass rvalues to the functions.
@@ -50,12 +50,14 @@
do not use built-in arrays,
- do not pass rvalues to begin () ,
- end () and iterator_range Range constructors
+ do not pass rvalues to begin () ,
+ end ()
+ and iterator_range Range constructors
and assignment operators,
- use const_begin () and const_end ()
+ use const_begin ()
+ and const_end ()
whenever your code by intention is read-only; this will also solve most rvalue
problems,
diff --git a/doc/html/range/reference.html b/doc/html/range/reference.html
index 2e597ea..cbff24d 100644
--- a/doc/html/range/reference.html
+++ b/doc/html/range/reference.html
@@ -28,17 +28,16 @@
|