[Boost-commit] svn:boost r65859 - sandbox/variadic_macro_data/libs/variadic_macro_data/doc

Subject: [Boost-commit] svn:boost r65859 - sandbox/variadic_macro_data/libs/variadic_macro_data/doc
From: eldiener_at_[hidden]
Date: 2010-10-09 11:31:10

Author: eldiener
Date: 2010-10-09 11:31:02 EDT (Sat, 09 Oct 2010)
New Revision: 65859
URL: http://svn.boost.org/trac/boost/changeset/65859

Log:
Updated docs
Text files modified: 
   sandbox/variadic_macro_data/libs/variadic_macro_data/doc/VMDComparison.qbk    |    29 ++++++++++++++---------------           
   sandbox/variadic_macro_data/libs/variadic_macro_data/doc/VMDCompilers.qbk     |    10 +++++++++-                              
   sandbox/variadic_macro_data/libs/variadic_macro_data/doc/VMDDesign.qbk        |     4 ++--                                    
   sandbox/variadic_macro_data/libs/variadic_macro_data/doc/VMDDetail.qbk        |     4 ++--                                    
   sandbox/variadic_macro_data/libs/variadic_macro_data/doc/VMDFunctionality.qbk |    16 +++++++---------                        
   sandbox/variadic_macro_data/libs/variadic_macro_data/doc/VMDIntroduction.qbk  |    11 +++++------                             
   sandbox/variadic_macro_data/libs/variadic_macro_data/doc/VMDNaming.qbk        |     3 +--                                     
   7 files changed, 40 insertions(+), 37 deletions(-)

Modified: sandbox/variadic_macro_data/libs/variadic_macro_data/doc/VMDComparison.qbk
==============================================================================
--- sandbox/variadic_macro_data/libs/variadic_macro_data/doc/VMDComparison.qbk	(original)
+++ sandbox/variadic_macro_data/libs/variadic_macro_data/doc/VMDComparison.qbk	2010-10-09 11:31:02 EDT (Sat, 09 Oct 2010)
@@ -1,4 +1,4 @@
-[section:vmd_comparison Variadic Macro Data Library and Boost PP]
+[section:vmd_comparison VMD and Boost PP]
 
 Boost PP already has the ability to pass variadic data
 as a single macro argument through any of its data types. 
@@ -12,10 +12,10 @@
   list of data mimics the way macro arguments are usually passed.
 # The length of the variadic data does not have to be passed.
   In Boost PP the length does not have to be passed for the 
-  sequences and lists, but it is specified as part of an array, and 
-  must be separately passed, or known in advance, for tuples. 
-  Functionality in this library, however, alleviates this last 
-  requirement for tuples.
+  sequences and lists, but it has to be specified as part of an 
+  array, and must be separately passed, or known in advance, for 
+  tuples. Functionality in this library, however, alleviates this 
+  last requirement for tuples.
   
 On the other hand there are considerations for using 
 Boost PP data types for passing variadic data to macros:
@@ -23,19 +23,18 @@
 # Boost PP data types can be passed multiple times in any macro 
   whereas variadic macros can only pass its variadic macro data 
   a single time as the final set of arguments to a macro. 
-# Boost PP data types are single macro arguments, which fits 
+# Boost PP data types, which are single macro arguments, fit 
   in well with Boost PP functionality.
 # Boost PP data types have a rich set of functionality for 
   manipulating the data in the data type.
 
-Nonetheless I feel that the more natural syntax of 
-variadic macro data still provides enough importance for using 
-this library's facilities from the end-user's point of view. 
-A macro writer can design macros for the end-user which take 
-variadic data using variadic macros while internally using 
-Boost PP data types to manipulate that data and pass that data 
-to other Boost PP macros. This library provides functionality 
-to do just that with its macros which convert from variadic macro 
-data to Boost PP data types.
+The more natural syntax of variadic macro data still provides 
+enough importance, from the end-user's point of view, for using 
+this library's facilities. A macro writer can design macros for 
+the end-user which take variadic data using variadic macros while 
+internally using Boost PP data types to manipulate that data and 
+pass that data to other Boost PP macros. This library provides 
+functionality to do just that with its macros which convert from 
+variadic macro data to Boost PP data types.
 
 [endsect]

Modified: sandbox/variadic_macro_data/libs/variadic_macro_data/doc/VMDCompilers.qbk
==============================================================================
--- sandbox/variadic_macro_data/libs/variadic_macro_data/doc/VMDCompilers.qbk	(original)
+++ sandbox/variadic_macro_data/libs/variadic_macro_data/doc/VMDCompilers.qbk	2010-10-09 11:31:02 EDT (Sat, 09 Oct 2010)
@@ -2,6 +2,14 @@
 
 A previously mentioned in the section 'Boost Support' the compilers supported 
 by this library must not have the Boost Config macro BOOST_NO_VARIADIC_MACROS 
-defined. I have tested this library using gcc/MingW and VC++ on Windows.
+defined. I have tested this library using gcc/MingW and VC++ on Windows. Other 
+compilers which currently should work with this library are gcc on Linux, 
+Digital Mars C++, and Borland C++ Builder 6/Codegear C++.
+
+Currently (10/09/2010) the macro BOOST_NO_VARIADIC_MACROS is defined for 
+compilers in the trunk. Since this macro specifies compilers which do not 
+support variadic data, this library could be used with previous Boost 
+installations but there would be no guarantee that the compilers for which 
+one wanted to use this library actually support variadic macros.
 
 [endsect]

Modified: sandbox/variadic_macro_data/libs/variadic_macro_data/doc/VMDDesign.qbk
==============================================================================
--- sandbox/variadic_macro_data/libs/variadic_macro_data/doc/VMDDesign.qbk	(original)
+++ sandbox/variadic_macro_data/libs/variadic_macro_data/doc/VMDDesign.qbk	2010-10-09 11:31:02 EDT (Sat, 09 Oct 2010)
@@ -1,9 +1,9 @@
 [section:vmd_design Design]
 
-The initial impetus for creating this library is entirely practical. I had been 
+The initial impetus for creating this library was entirely practical. I had been 
 working on another library of macro functionality, which used Boost PP 
 functionality, and I realized that if I could use variadic macros with 
-my other library, the end-user usability for that library would be much easier. 
+my other library, the end-user usability for that library would be easier. 
 Therefore the main design goal of this library is to interoperate variadic macro data 
 with Boost PP in the easiest and clearest way possible.
 

Modified: sandbox/variadic_macro_data/libs/variadic_macro_data/doc/VMDDetail.qbk
==============================================================================
--- sandbox/variadic_macro_data/libs/variadic_macro_data/doc/VMDDetail.qbk	(original)
+++ sandbox/variadic_macro_data/libs/variadic_macro_data/doc/VMDDetail.qbk	2010-10-09 11:31:02 EDT (Sat, 09 Oct 2010)
@@ -1,7 +1,7 @@
 [section:vmd_detail Functional groups]
 
-The macros in the variadic macro data library can best be explained 
-as falling into four groups. These are:
+The macros in VMD can best be explained as falling into four groups. 
+These are:
 
 # Macros which directly support variadic macro data usage.
 # Macros which convert variadic macro data to Boost PP data types.

Modified: sandbox/variadic_macro_data/libs/variadic_macro_data/doc/VMDFunctionality.qbk
==============================================================================
--- sandbox/variadic_macro_data/libs/variadic_macro_data/doc/VMDFunctionality.qbk	(original)
+++ sandbox/variadic_macro_data/libs/variadic_macro_data/doc/VMDFunctionality.qbk	2010-10-09 11:31:02 EDT (Sat, 09 Oct 2010)
@@ -21,17 +21,15 @@
 token from the variadic macro data and use that as a single argument, 
 or by combining individual tokens from the variadic 
 macro data into Boost PP data types using the functionality of the 
-Boost PP data type to do so.
-
-The variadic macro data library provides means to interoperate 
+Boost PP data type to do so. VMD provides means to interoperate 
 variadic macro data with Boost PP in these ways.
 
-Outside of Boost PP interoperability, the variadic macro data library 
-allows individual tokens to be extracted from the variadic macro data 
-and used in macro expansion or passed to other macross.
+Outside of Boost PP interoperability, VMD allows individual tokens to 
+be extracted from the variadic macro data and used in macro expansion 
+or passed to other macross.
 
-Finally through the functionality of variadic macros, the variadic macro 
-data library provides parallel functionality to the Boost PP tuple 
-interface macros which does not need the size of a tuple to be specified.
+Finally through the functionality of variadic macros, VMD provides parallel 
+functionality to the Boost PP tuple interface macros with a set of macros 
+which do not need the size of a tuple to be specified.
    
 [endsect]

Modified: sandbox/variadic_macro_data/libs/variadic_macro_data/doc/VMDIntroduction.qbk
==============================================================================
--- sandbox/variadic_macro_data/libs/variadic_macro_data/doc/VMDIntroduction.qbk	(original)
+++ sandbox/variadic_macro_data/libs/variadic_macro_data/doc/VMDIntroduction.qbk	2010-10-09 11:31:02 EDT (Sat, 09 Oct 2010)
@@ -1,11 +1,10 @@
 [section:vmd_intro Introduction]
 
-The variadic macro data library is a library of macros which 
-provide important functionality for variadic macros as well as 
-integrating variadic macros with the Boost preprocessor library, 
-to be referred to as just 'Boost PP' in this documentation. 
-It integrates with Boost PP without changing the 
-latter library in any way.
+The variadic macro data library, or VMD for short, is a library 
+of macros which provide important functionality for variadic 
+macros as well as integrating variadic macros with the Boost 
+preprocessor library ( Boost PP ). It integrates with Boost PP 
+without changing the latter library in any way.
 
 The functionality of the library may be summed up as:
 

Modified: sandbox/variadic_macro_data/libs/variadic_macro_data/doc/VMDNaming.qbk
==============================================================================
--- sandbox/variadic_macro_data/libs/variadic_macro_data/doc/VMDNaming.qbk	(original)
+++ sandbox/variadic_macro_data/libs/variadic_macro_data/doc/VMDNaming.qbk	2010-10-09 11:31:02 EDT (Sat, 09 Oct 2010)
@@ -6,8 +6,7 @@
 as the prefix instead.
 
 Following the prefix, certain names in the macros refer to data types 
-in this library or Boost PP. These names and their data 
-types are:
+in this library or Boost PP. These names and their data types are:
 
 # DATA  = variadic macro data as represented by '...' in a variadic 
   macro signature and \_\_VA\_ARGS\_\_ in variadic macro expansion.