Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r78229 - in trunk/libs/local_function/doc: . html
From: lorcaminiti_at_[hidden]
Date: 2012-04-27 22:06:04

Author: lcaminiti
Date: 2012-04-27 22:06:02 EDT (Fri, 27 Apr 2012)
New Revision: 78229
URL: http://svn.boost.org/trac/boost/changeset/78229

Log:
Replacing old with new docs.
Removed:
   trunk/libs/local_function/doc/html/
Text files modified:
   trunk/libs/local_function/doc/Jamfile.v2 | 2 +-
   trunk/libs/local_function/doc/acknowledgements.qbk | 2 +-
   trunk/libs/local_function/doc/advanced_topics.qbk | 8 ++++----
   trunk/libs/local_function/doc/alternatives.qbk | 2 +-
   trunk/libs/local_function/doc/bibliography.qbk | 2 +-
   trunk/libs/local_function/doc/examples.qbk | 2 +-
   trunk/libs/local_function/doc/getting_started.qbk | 2 +-
   trunk/libs/local_function/doc/implementation.qbk | 2 +-
   trunk/libs/local_function/doc/introduction.qbk | 2 +-
   trunk/libs/local_function/doc/local_function.qbk | 22 +++++++++++-----------
   trunk/libs/local_function/doc/no_variadic_macros.qbk | 2 +-
   trunk/libs/local_function/doc/release_notes.qbk | 2 +-
   trunk/libs/local_function/doc/tutorial.qbk | 2 +-
   13 files changed, 26 insertions(+), 26 deletions(-)

Modified: trunk/libs/local_function/doc/Jamfile.v2
==============================================================================
--- trunk/libs/local_function/doc/Jamfile.v2 (original)
+++ trunk/libs/local_function/doc/Jamfile.v2 2012-04-27 22:06:02 EDT (Fri, 27 Apr 2012)
@@ -17,7 +17,7 @@
 <doxygen:param>WARN_IF_UNDOCUMENTED=NO
 <doxygen:param>HIDE_UNDOC_MEMBERS=YES
 <doxygen:param>HIDE_UNDOC_CLASSES=YES
- <doxygen:param>ALIASES=" Params=\"Parameters: <table border="0">\" Param{2}=\"<tr><td><tt>\\1</tt></td><td>\\2</td></tr>\" EndParams=\"</table>\" Returns=\"Returns:\" Note=\"Note:\" Warning=\"Warning:\" See=\"See:\" RefSect{1}=\"\\xmlonly<link linkend='boost_localfunction.\\1'>\\1</link>\\endxmlonly\" RefSectId{2}=\"\\xmlonly<link linkend='boost_localfunction.\\1'>\\2</link>\\endxmlonly\" RefClass{1}=\"\\xmlonly<computeroutput><classname alt='\\1'>\\1</classname></computeroutput>\\endxmlonly\" RefFunc{1}=\"\\xmlonly<computeroutput><functionname alt='\\1'>\\1</functionname></computeroutput>\\endxmlonly\" RefMacro{1}=\"\\xmlonly<computeroutput><macroname alt='\\1'>\\1</macroname></computeroutput>\\endxmlonly\" "
+ <doxygen:param>ALIASES=" Params=\"Parameters: <table border="0">\" Param{2}=\"<tr><td><tt>\\1</tt></td><td>\\2</td></tr>\" EndParams=\"</table>\" Returns=\"Returns:\" Note=\"Note:\" Warning=\"Warning:\" See=\"See:\" RefSect{2}=\"\\xmlonly<link linkend='boost_localfunction.\\1'>\\2</link>\\endxmlonly\" RefClass{1}=\"\\xmlonly<computeroutput><classname alt='\\1'>\\1</classname></computeroutput>\\endxmlonly\" RefFunc{1}=\"\\xmlonly<computeroutput><functionname alt='\\1'>\\1</functionname></computeroutput>\\endxmlonly\" RefMacro{1}=\"\\xmlonly<computeroutput><macroname alt='\\1'>\\1</macroname></computeroutput>\\endxmlonly\" "
 ;

xml qbk : local_function.qbk

Modified: trunk/libs/local_function/doc/acknowledgements.qbk
==============================================================================
--- trunk/libs/local_function/doc/acknowledgements.qbk (original)
+++ trunk/libs/local_function/doc/acknowledgements.qbk 2012-04-27 22:06:02 EDT (Fri, 27 Apr 2012)
@@ -5,7 +5,7 @@
[/ http://www.boost.org/LICENSE_1_0.txt) ]
[/ Home at http://www.boost.org/libs/local_function ]

-[section:Acknowledgments Acknowledgments]
+[section Acknowledgments]

This section aims to recognize the contributions of /all/ the different people that participated directly or indirectly to the design and development of this library.

Modified: trunk/libs/local_function/doc/advanced_topics.qbk
==============================================================================
--- trunk/libs/local_function/doc/advanced_topics.qbk (original)
+++ trunk/libs/local_function/doc/advanced_topics.qbk 2012-04-27 22:06:02 EDT (Fri, 27 Apr 2012)
@@ -5,7 +5,7 @@
[/ http://www.boost.org/LICENSE_1_0.txt) ]
[/ Home at http://www.boost.org/libs/local_function ]

-[section:Advanced_Topics Advanced Topics]
+[section Advanced Topics]

This section illustrates advanced usage of this library.
At the bottom there is also a list of known limitations of this library.
@@ -371,18 +371,18 @@
Note that the [macroref BOOST_LOCAL_FUNCTION_NAME] macro can always be expanded multiple times on the same line because the unique local function name (and not `__LINE__`) is used by this macro to generate unique identifiers (so there is no need for a `BOOST_LOCAL_FUNCTION_NAME_ID` macro).
]

-Therefore, this library provides additional macros [macroref BOOST_LOCAL_FUNCTION_ID] and [macroref BOOST_LOCAL_FUNCTION_TPL_ID] which can be expanded multiple times on the same line as long as programmers specify unique identifiers as the macros' first parameters.
+Therefore, this library provides additional macros [macroref BOOST_LOCAL_FUNCTION_ID] and [macroref BOOST_LOCAL_FUNCTION_ID_TPL] which can be expanded multiple times on the same line as long as programmers specify unique identifiers as the macros' first parameters.
The unique identifier can be any token (not just numeric) that can be successfully concatenated by the preprocessor (e.g., `local_function_number_1_at_line_123`).
[footnote
Because there are restrictions on the set of tokens that the preprocessor can concatenate and because not all compilers correctly implement these restrictions, it is in general recommended to specify unique identifiers as a combination of alphanumeric tokens.
]

-The [macroref BOOST_LOCAL_FUNCTION_ID] and [macroref BOOST_LOCAL_FUNCTION_TPL_ID] macros accept local function parameter declaration lists using the exact same syntax as [macroref BOOST_LOCAL_FUNCTION].
+The [macroref BOOST_LOCAL_FUNCTION_ID] and [macroref BOOST_LOCAL_FUNCTION_ID_TPL] macros accept local function parameter declaration lists using the exact same syntax as [macroref BOOST_LOCAL_FUNCTION].
For example (see also [@../../test/same_line.cpp =same_line.cpp=]):

[same_line]

-As shown by the example above, the [macroref BOOST_LOCAL_FUNCTION_ID] and [macroref BOOST_LOCAL_FUNCTION_TPL_ID] macros are especially useful when it is necessary to invoke them multiple times within a user-defined macro (because the preprocessor expands all nested macros on the same line).
+As shown by the example above, the [macroref BOOST_LOCAL_FUNCTION_ID] and [macroref BOOST_LOCAL_FUNCTION_ID_TPL] macros are especially useful when it is necessary to invoke them multiple times within a user-defined macro (because the preprocessor expands all nested macros on the same line).

[endsect]

Modified: trunk/libs/local_function/doc/alternatives.qbk
==============================================================================
--- trunk/libs/local_function/doc/alternatives.qbk (original)
+++ trunk/libs/local_function/doc/alternatives.qbk 2012-04-27 22:06:02 EDT (Fri, 27 Apr 2012)
@@ -5,7 +5,7 @@
[/ http://www.boost.org/LICENSE_1_0.txt) ]
[/ Home at http://www.boost.org/libs/local_function ]

-[section:Alternatives Annex: Alternatives]
+[section:alternatives Annex: Alternatives]

This section compares the features offered by this library with similar features offered by C++ and by other libraries.

Modified: trunk/libs/local_function/doc/bibliography.qbk
==============================================================================
--- trunk/libs/local_function/doc/bibliography.qbk (original)
+++ trunk/libs/local_function/doc/bibliography.qbk 2012-04-27 22:06:02 EDT (Fri, 27 Apr 2012)
@@ -5,7 +5,7 @@
[/ http://www.boost.org/LICENSE_1_0.txt) ]
[/ Home at http://www.boost.org/libs/local_function ]

-[section:Bibliography Bibliography]
+[section Bibliography]

This section lists all the bibliographic references cited by this documentation.

Modified: trunk/libs/local_function/doc/examples.qbk
==============================================================================
--- trunk/libs/local_function/doc/examples.qbk (original)
+++ trunk/libs/local_function/doc/examples.qbk 2012-04-27 22:06:02 EDT (Fri, 27 Apr 2012)
@@ -5,7 +5,7 @@
[/ http://www.boost.org/LICENSE_1_0.txt) ]
[/ Home at http://www.boost.org/libs/local_function ]

-[section:Examples Examples]
+[section Examples]

This section lists some examples that use this library.

Modified: trunk/libs/local_function/doc/getting_started.qbk
==============================================================================
--- trunk/libs/local_function/doc/getting_started.qbk (original)
+++ trunk/libs/local_function/doc/getting_started.qbk 2012-04-27 22:06:02 EDT (Fri, 27 Apr 2012)
@@ -5,7 +5,7 @@
[/ http://www.boost.org/LICENSE_1_0.txt) ]
[/ Home at http://www.boost.org/libs/local_function ]

-[section:Getting_Started Getting Started]
+[section Getting Started]

This section explains how to setup a system to use this library.

Modified: trunk/libs/local_function/doc/implementation.qbk
==============================================================================
--- trunk/libs/local_function/doc/implementation.qbk (original)
+++ trunk/libs/local_function/doc/implementation.qbk 2012-04-27 22:06:02 EDT (Fri, 27 Apr 2012)
@@ -5,7 +5,7 @@
[/ http://www.boost.org/LICENSE_1_0.txt) ]
[/ Home at http://www.boost.org/libs/local_function ]

-[section:Implementation Annex: Implementation]
+[section:implementation Annex: Implementation]

This section gives an overview of the key programming techniques used to implement this library.

Modified: trunk/libs/local_function/doc/introduction.qbk
==============================================================================
--- trunk/libs/local_function/doc/introduction.qbk (original)
+++ trunk/libs/local_function/doc/introduction.qbk 2012-04-27 22:06:02 EDT (Fri, 27 Apr 2012)
@@ -5,7 +5,7 @@
[/ http://www.boost.org/LICENSE_1_0.txt) ]
[/ Home at http://www.boost.org/libs/local_function ]

-[section:Introduction Introduction]
+[section Introduction]

/Local functions/ (a.k.a., [@http://en.wikipedia.org/wiki/Nested_function /nested functions/]) are a form of /information hiding/ and they are useful for dividing procedural tasks into subtasks which are only meaningful locally, avoiding cluttering other parts of the program with functions, variables, etc unrelated to those parts.
Therefore, local functions complement other structuring possibilities such as namespaces and classes.

Modified: trunk/libs/local_function/doc/local_function.qbk
==============================================================================
--- trunk/libs/local_function/doc/local_function.qbk (original)
+++ trunk/libs/local_function/doc/local_function.qbk 2012-04-27 22:06:02 EDT (Fri, 27 Apr 2012)
@@ -50,18 +50,18 @@
[def __N2550__ [@http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2550.pdf \[N2550\]]]
[def __N2657__ [@http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2657.htm \[N2657\]]]

-[def __Introduction__ [link boost_localfunction.Introduction Introduction]]
-[def __Getting_Started__ [link boost_localfunction.Getting_Started Getting Started]]
-[def __Tutorial__ [link boost_localfunction.Tutorial Tutorial]]
-[def __Advanced_Topics__ [link boost_localfunction.Advanced_Topics Advanced Topics]]
-[def __Examples__ [link boost_localfunction.Examples Examples]]
+[def __Introduction__ [link boost_localfunction.introduction Introduction]]
+[def __Getting_Started__ [link boost_localfunction.getting_started Getting Started]]
+[def __Tutorial__ [link boost_localfunction.tutorial Tutorial]]
+[def __Advanced_Topics__ [link boost_localfunction.advanced_topics Advanced Topics]]
+[def __Examples__ [link boost_localfunction.examples Examples]]
[def __Reference__ [@reference.html Reference]]
-[def __Alternatives__ [link boost_localfunction.Alternatives Alternatives]]
-[def __No_Variadic_Macros__ [link boost_localfunction.No_Variadic_Macros No Variadic Macros]]
-[def __Implementation__ [link boost_localfunction.Implementation Implementation]]
-[def __Release_Notes__ [link boost_localfunction.Release_Notes Release Notes]]
-[def __Bibliography__ [link boost_localfunction.Bibliography Bibliography]]
-[def __Acknowledgments__ [link boost_localfunction.Acknowledgments Acknowledgments]]
+[def __Alternatives__ [link boost_localfunction.alternatives Alternatives]]
+[def __No_Variadic_Macros__ [link boost_localfunction.no_variadic_macros No Variadic Macros]]
+[def __Implementation__ [link boost_localfunction.implementation Implementation]]
+[def __Release_Notes__ [link boost_localfunction.release_notes Release Notes]]
+[def __Bibliography__ [link boost_localfunction.bibliography Bibliography]]
+[def __Acknowledgments__ [link boost_localfunction.acknowledgments Acknowledgments]]

[import ../test/add.cpp]
[import ../test/add_seq.cpp]

Modified: trunk/libs/local_function/doc/no_variadic_macros.qbk
==============================================================================
--- trunk/libs/local_function/doc/no_variadic_macros.qbk (original)
+++ trunk/libs/local_function/doc/no_variadic_macros.qbk 2012-04-27 22:06:02 EDT (Fri, 27 Apr 2012)
@@ -5,7 +5,7 @@
[/ http://www.boost.org/LICENSE_1_0.txt) ]
[/ Home at http://www.boost.org/libs/local_function ]

-[section:No_Variadic_Macros Annex: No Variadic Macros]
+[section:no_variadic_macros Annex: No Variadic Macros]

This section illustrates an alternative syntax for compilers without variadic macro support.

Modified: trunk/libs/local_function/doc/release_notes.qbk
==============================================================================
--- trunk/libs/local_function/doc/release_notes.qbk (original)
+++ trunk/libs/local_function/doc/release_notes.qbk 2012-04-27 22:06:02 EDT (Fri, 27 Apr 2012)
@@ -5,7 +5,7 @@
[/ http://www.boost.org/LICENSE_1_0.txt) ]
[/ Home at http://www.boost.org/libs/local_function ]

-[section:Release_Notes Release Notes]
+[section Release Notes]

This section lists the major changes between different library releases (in chronological order).

Modified: trunk/libs/local_function/doc/tutorial.qbk
==============================================================================
--- trunk/libs/local_function/doc/tutorial.qbk (original)
+++ trunk/libs/local_function/doc/tutorial.qbk 2012-04-27 22:06:02 EDT (Fri, 27 Apr 2012)
@@ -5,7 +5,7 @@
[/ http://www.boost.org/LICENSE_1_0.txt) ]
[/ Home at http://www.boost.org/libs/local_function ]

-[section:Tutorial Tutorial]
+[section Tutorial]

This section illustrates basic usage of this library.

Date view	Thread view	Subject view	Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk