From b03b732a196ab5beda598ed540698dd203628a15 Mon Sep 17 00:00:00 2001 From: Edward Diener Date: Sat, 23 Nov 2013 03:59:40 +0000 Subject: [PATCH] Updated documentation for tuples. [SVN r86788] --- doc/headers.html | 472 ++++++++++++----------- doc/headers/tuple.html | 88 +++-- doc/headers/tuple/insert.html | 5 +- doc/headers/tuple/pop_back.html | 6 +- doc/headers/tuple/pop_front.html | 6 +- doc/headers/tuple/push_back.html | 3 +- doc/headers/tuple/push_front.html | 3 +- doc/headers/tuple/remove.html | 5 +- doc/headers/tuple/replace.html | 6 +- doc/ref.html | 609 +++++++++++++++--------------- doc/ref/tuple_insert.html | 3 +- doc/ref/tuple_insert_d.html | 2 +- doc/ref/tuple_pop_back.html | 2 +- doc/ref/tuple_pop_back_z.html | 8 +- doc/ref/tuple_pop_front.html | 7 +- doc/ref/tuple_pop_front_z.html | 3 +- doc/ref/tuple_push_back.html | 3 +- doc/ref/tuple_push_front.html | 3 +- doc/ref/tuple_remove.html | 3 +- doc/ref/tuple_remove_d.html | 2 +- doc/ref/tuple_replace.html | 3 +- doc/ref/tuple_replace_d.html | 2 +- 22 files changed, 653 insertions(+), 591 deletions(-) diff --git a/doc/headers.html b/doc/headers.html index 712b05e..90b59fd 100644 --- a/doc/headers.html +++ b/doc/headers.html @@ -1,233 +1,247 @@ - - headers.html - - - - - -

Headers [back] -

- - - + + +

Headers [back] +

+ + + diff --git a/doc/headers/tuple.html b/doc/headers/tuple.html index 4117e89..96da3cb 100644 --- a/doc/headers/tuple.html +++ b/doc/headers/tuple.html @@ -1,37 +1,59 @@ - + + tuple.hpp - - - -
- The tuple.hpp includes the headers in the tuple folder. -
-

Usage

-
- #include <boost/preprocessor/tuple.hpp> -
-

Includes

+ + + +
The tuple.hpp includes the headers + in the tuple folder.
+

Usage

+
#include <boost/preprocessor/tuple.hpp>
+

Includes

-
-
- © Copyright Housemarque Oy 2002 -
© Copyright Paul Mensonides 2002 -
-
-

Distributed under the Boost Software License, Version 1.0. (See - accompanying file LICENSE_1_0.txt or - copy at www.boost.org/LICENSE_1_0.txt)

-
- +
  • <boost/preprocessor/tuple/eat.hpp> + (v)
    • +
  • <boost/preprocessor/tuple/elem.hpp> + (v)
    • +
  • <boost/preprocessor/tuple/enum.hpp> + (v)
    • +
  • <boost/preprocessor/tuple/insert.hpp> + (v)
    • +
  • <boost/preprocessor/tuple/pop_back.hpp> + (v)
    • +
  • <boost/preprocessor/tuple/pop_front.hpp> + (v)
    • +
  • <boost/preprocessor/tuple/push_back.hpp> + (v)
    • +
  • <boost/preprocessor/tuple/push_front.hpp> + (v)
    • +
  • <boost/preprocessor/tuple/rem.hpp> + (v)
    • +
  • <boost/preprocessor/tuple/remove.hpp> + (v)
    • +
  • <boost/preprocessor/tuple/replace.hpp> + (v)
    • +
  • <boost/preprocessor/tuple/reverse.hpp> + (v)
    • +
  • <boost/preprocessor/tuple/size.hpp> + (v)
    • +
  • <boost/preprocessor/tuple/to_array.hpp> + (v)
    • +
  • <boost/preprocessor/tuple/to_list.hpp> + (v)
    • +
  • <boost/preprocessor/tuple/to_seq.hpp> + (v)
    • + +
    +
    © Copyright Housemarque Oy 2002
    + © Copyright Paul Mensonides 2002
    +     © Copyright Edward Diener 2013
    +
    +
    +

    Distributed under the Boost Software License, Version 1.0. (See + accompanying file LICENSE_1_0.txt + or copy at www.boost.org/LICENSE_1_0.txt)

    +
    + diff --git a/doc/headers/tuple/insert.html b/doc/headers/tuple/insert.html index e6d1b8a..2af84b4 100644 --- a/doc/headers/tuple/insert.html +++ b/doc/headers/tuple/insert.html @@ -12,8 +12,9 @@

    Contents

    © Copyright Edward Diener 2013
    diff --git a/doc/headers/tuple/pop_back.html b/doc/headers/tuple/pop_back.html index 23f3c24..e6edefc 100644 --- a/doc/headers/tuple/pop_back.html +++ b/doc/headers/tuple/pop_back.html @@ -12,8 +12,10 @@

    Contents

    © Copyright Edward Diener 2013
    diff --git a/doc/headers/tuple/pop_front.html b/doc/headers/tuple/pop_front.html index 6a71a7a..633acdb 100644 --- a/doc/headers/tuple/pop_front.html +++ b/doc/headers/tuple/pop_front.html @@ -12,8 +12,10 @@

    Contents

    © Copyright Edward Diener 2013
    diff --git a/doc/headers/tuple/push_back.html b/doc/headers/tuple/push_back.html index cf3b4fc..9cedd21 100644 --- a/doc/headers/tuple/push_back.html +++ b/doc/headers/tuple/push_back.html @@ -12,7 +12,8 @@

    Contents

    © Copyright Edward Diener 2013
    diff --git a/doc/headers/tuple/push_front.html b/doc/headers/tuple/push_front.html index 567daea..7d5510b 100644 --- a/doc/headers/tuple/push_front.html +++ b/doc/headers/tuple/push_front.html @@ -12,7 +12,8 @@

    Contents

    © Copyright Edward Diener 2013
    diff --git a/doc/headers/tuple/remove.html b/doc/headers/tuple/remove.html index 7204a66..651113c 100644 --- a/doc/headers/tuple/remove.html +++ b/doc/headers/tuple/remove.html @@ -12,8 +12,9 @@

    Contents

    © Copyright Edward Diener 2013
    diff --git a/doc/headers/tuple/replace.html b/doc/headers/tuple/replace.html index 0cff9cf..03ca25d 100644 --- a/doc/headers/tuple/replace.html +++ b/doc/headers/tuple/replace.html @@ -12,8 +12,10 @@

    Contents

    © Copyright Edward Diener 2013
    diff --git a/doc/ref.html b/doc/ref.html index 145753d..82c2905 100644 --- a/doc/ref.html +++ b/doc/ref.html @@ -1,305 +1,316 @@ + ref.html - - + + -

    Reference [back] -

    - - +

    Reference [back] +

    + + - \ No newline at end of file + diff --git a/doc/ref/tuple_insert.html b/doc/ref/tuple_insert.html index ba21cd5..0c58681 100644 --- a/doc/ref/tuple_insert.html +++ b/doc/ref/tuple_insert.html @@ -8,7 +8,8 @@
    The BOOST_PP_TUPLE_INSERT macro inserts an element into an tuple.

    Usage

    -
    BOOST_PP_TUPLE_INSERT(tuple, i, elem)
    +
    BOOST_PP_TUPLE_INSERT(tuple, i, elem) + (v)

    Arguments

    tuple
    diff --git a/doc/ref/tuple_insert_d.html b/doc/ref/tuple_insert_d.html index ce28076..53fbea1 100644 --- a/doc/ref/tuple_insert_d.html +++ b/doc/ref/tuple_insert_d.html @@ -10,7 +10,7 @@ with maximum efficiency.

    Usage

    BOOST_PP_TUPLE_INSERT_D(d, tuple, - i, elem)
    + i, elem) (v)

    Arguments

    d
    diff --git a/doc/ref/tuple_pop_back.html b/doc/ref/tuple_pop_back.html index 470bc69..63df90a 100644 --- a/doc/ref/tuple_pop_back.html +++ b/doc/ref/tuple_pop_back.html @@ -8,7 +8,7 @@
    The BOOST_PP_TUPLE_POP_BACK macro pops an element from the end of an tuple.

    Usage

    -
    BOOST_PP_TUPLE_POP_BACK(tuple)
    +
    BOOST_PP_TUPLE_POP_BACK(tuple) (v)

    Arguments

    tuple
    diff --git a/doc/ref/tuple_pop_back_z.html b/doc/ref/tuple_pop_back_z.html index b38c788..99b26c6 100644 --- a/doc/ref/tuple_pop_back_z.html +++ b/doc/ref/tuple_pop_back_z.html @@ -9,7 +9,8 @@ pops an element from the end of an tuple.  It reenters BOOST_PP_REPEAT with maximum efficiency.

    Usage

    -
    BOOST_PP_TUPLE_POP_BACK_Z(z, tuple)
    +
    BOOST_PP_TUPLE_POP_BACK_Z(z, tuple) + (v)

    Arguments

    z
    @@ -19,9 +20,8 @@

    Remarks

    This macro returns tuple after removing the last - element.  - If tuple has only a single element, it remains unchanged since - a tuple must have at least one element.
    + element.  If tuple has only a single element, it remains + unchanged since a tuple must have at least one element.

    See Also

    • BOOST_PP_TUPLE_POP_BACK
      • diff --git a/doc/ref/tuple_pop_front.html b/doc/ref/tuple_pop_front.html index 45d46b4..ca388ce 100644 --- a/doc/ref/tuple_pop_front.html +++ b/doc/ref/tuple_pop_front.html @@ -8,7 +8,7 @@
      The BOOST_PP_TUPLE_POP_FRONT macro pops an element from the beginning of a tuple.

      Usage

      -
      BOOST_PP_TUPLE_POP_FRONT(tuple)
      +
      BOOST_PP_TUPLE_POP_FRONT(tuple) (v)

      Arguments

      tuple
      @@ -16,9 +16,8 @@

      Remarks

      This macro returns tuple after removing the first - element.  - If tuple has only a single element, it remains unchanged since - a tuple must have at least one element.
      + element.  If tuple has only a single element, it remains + unchanged since a tuple must have at least one element.
      This macro uses BOOST_PP_REPEAT internally.  Therefore, to use the z parameter passed from other macros that use BOOST_PP_REPEAT, see BOOST_PP_TUPLE_POP_FRONT_Z
      diff --git a/doc/ref/tuple_pop_front_z.html b/doc/ref/tuple_pop_front_z.html index 5286233..d65e7f4 100644 --- a/doc/ref/tuple_pop_front_z.html +++ b/doc/ref/tuple_pop_front_z.html @@ -9,7 +9,8 @@ macro pops an element from the beginning of a tuple.  It reenters BOOST_PP_REPEAT with maximum efficiency.

      Usage

      -
      BOOST_PP_TUPLE_POP_FRONT_Z(z, tuple)
      +
      BOOST_PP_TUPLE_POP_FRONT_Z(z, tuple) + (v)

      Arguments

      z
      diff --git a/doc/ref/tuple_push_back.html b/doc/ref/tuple_push_back.html index 4633457..3ebc99c 100644 --- a/doc/ref/tuple_push_back.html +++ b/doc/ref/tuple_push_back.html @@ -8,7 +8,8 @@
      The BOOST_PP_TUPLE_PUSH_BACK macro appends an element to the end of a tuple.

      Usage

      -
      BOOST_PP_TUPLE_PUSH_BACK(tuple, elem)
      +
      BOOST_PP_TUPLE_PUSH_BACK(tuple, elem) + (v)

      Arguments

      tuple
      diff --git a/doc/ref/tuple_push_front.html b/doc/ref/tuple_push_front.html index 164791c..cfabc88 100644 --- a/doc/ref/tuple_push_front.html +++ b/doc/ref/tuple_push_front.html @@ -8,7 +8,8 @@
      The BOOST_PP_TUPLE_PUSH_FRONT macro appends an element to the beginning of a tuple.

      Usage

      -
      BOOST_PP_TUPLE_PUSH_FRONT(tuple, elem)
      +
      BOOST_PP_TUPLE_PUSH_FRONT(tuple, elem) + (v)

      Arguments

      tuple
      diff --git a/doc/ref/tuple_remove.html b/doc/ref/tuple_remove.html index 5e3396f..4aebc57 100644 --- a/doc/ref/tuple_remove.html +++ b/doc/ref/tuple_remove.html @@ -8,7 +8,8 @@
      The BOOST_PP_TUPLE_REMOVE macro removes an element from a tuple.

      Usage

      -
      BOOST_PP_TUPLE_REMOVE(tuple, i)
      +
      BOOST_PP_TUPLE_REMOVE(tuple, i) (v)

      Arguments

      tuple
      diff --git a/doc/ref/tuple_remove_d.html b/doc/ref/tuple_remove_d.html index 3b6cab9..1be3d1c 100644 --- a/doc/ref/tuple_remove_d.html +++ b/doc/ref/tuple_remove_d.html @@ -10,7 +10,7 @@ with maximum efficiency.

      Usage

      BOOST_PP_TUPLE_REMOVE_D(d, tuple, - i)
      + i) (v)

      Arguments

      d
      diff --git a/doc/ref/tuple_replace.html b/doc/ref/tuple_replace.html index 7931038..8654ebb 100644 --- a/doc/ref/tuple_replace.html +++ b/doc/ref/tuple_replace.html @@ -8,7 +8,8 @@
      The BOOST_PP_TUPLE_REPLACE macro replaces an element in a tuple.

      Usage

      -
      BOOST_PP_TUPLE_REPLACE(tuple, i, elem)
      +
      BOOST_PP_TUPLE_REPLACE(tuple, i, elem) + (v)

      Arguments

      tuple
      diff --git a/doc/ref/tuple_replace_d.html b/doc/ref/tuple_replace_d.html index 63dd12d..dc5fc4f 100644 --- a/doc/ref/tuple_replace_d.html +++ b/doc/ref/tuple_replace_d.html @@ -10,7 +10,7 @@ with maximum efficiency.

      Usage

      BOOST_PP_TUPLE_REPLACE_D(d, tuple, - i, elem)
      + i, elem) (v)

      Arguments

      d