|
|
Boost-Commit : |
From: srajko_at_[hidden]
Date: 2007-05-22 12:23:21
Author: srajko
Date: 2007-05-22 12:23:20 EDT (Tue, 22 May 2007)
New Revision: 4180
URL: http://svn.boost.org/trac/boost/changeset/4180
Log:
Change substitution templates to $template_*$ format
Added:
sandbox/template_under_construction/$template_library$/boost/$template_library$/
- copied from r4178, /sandbox/template_under_construction/$template_library$/boost/_library_/
sandbox/template_under_construction/$template_library$/boost/$template_library$.hpp
- copied, changed from r4178, /sandbox/template_under_construction/$template_library$/boost/_library_.hpp
sandbox/template_under_construction/$template_library$/boost/$template_library$/$template_library$.hpp
- copied, changed from r4178, /sandbox/template_under_construction/$template_library$/boost/_library_/_library_.hpp
sandbox/template_under_construction/$template_library$/libs/$template_library$/doc/$template_library$.qbk
- copied, changed from r4178, /sandbox/template_under_construction/$template_library$/libs/$template_library$/doc/_library_.qbk
sandbox/template_under_construction/$template_library$/libs/$template_library$/doc/dox/$template_library$.hpp
- copied, changed from r4178, /sandbox/template_under_construction/$template_library$/libs/$template_library$/doc/dox/_library_.hpp
sandbox/template_under_construction/$template_library$/libs/$template_library$/vc8ide/$template_library$.sln
- copied unchanged from r4178, /sandbox/template_under_construction/$template_library$/libs/$template_library$/vc8ide/_library_.sln
Removed:
sandbox/template_under_construction/$template_library$/boost/$template_library$/_library_.hpp
sandbox/template_under_construction/$template_library$/boost/_library_/
sandbox/template_under_construction/$template_library$/boost/_library_.hpp
sandbox/template_under_construction/$template_library$/libs/$template_library$/doc/_library_.qbk
sandbox/template_under_construction/$template_library$/libs/$template_library$/doc/dox/_library_.hpp
sandbox/template_under_construction/$template_library$/libs/$template_library$/vc8ide/_library_.sln
Text files modified:
sandbox/template_under_construction/$template_library$/boost/$template_library$.hpp | 6 ++--
sandbox/template_under_construction/$template_library$/boost/$template_library$/$template_library$.hpp | 6 ++--
sandbox/template_under_construction/$template_library$/libs/$template_library$/doc/$template_library$.qbk | 42 +++++++++++++++++++--------------------
sandbox/template_under_construction/$template_library$/libs/$template_library$/doc/dox/$template_library$.hpp | 2 +
4 files changed, 28 insertions(+), 28 deletions(-)
Copied: sandbox/template_under_construction/$template_library$/boost/$template_library$.hpp (from r4178, /sandbox/template_under_construction/$template_library$/boost/_library_.hpp)
==============================================================================
--- /sandbox/template_under_construction/$template_library$/boost/_library_.hpp (original)
+++ sandbox/template_under_construction/$template_library$/boost/$template_library$.hpp 2007-05-22 12:23:20 EDT (Tue, 22 May 2007)
@@ -6,10 +6,10 @@
$template_start$
$template_cpp_copyright$
-#ifndef BOOST_$TEMPLATE_LIBRARY$_HPP
-#define BOOST_$TEMPLATE_LIBRARY$_HPP
+#ifndef BOOST_$template_LIBRARY$_HPP
+#define BOOST_$template_LIBRARY$_HPP
#include <boost/$template_library$/$template_library$.hpp>
-#endif // BOOST_$TEMPLATE_LIBRARY$_HPP
+#endif // BOOST_$template_LIBRARY$_HPP
Copied: sandbox/template_under_construction/$template_library$/boost/$template_library$/$template_library$.hpp (from r4178, /sandbox/template_under_construction/$template_library$/boost/_library_/_library_.hpp)
==============================================================================
--- /sandbox/template_under_construction/$template_library$/boost/_library_/_library_.hpp (original)
+++ sandbox/template_under_construction/$template_library$/boost/$template_library$/$template_library$.hpp 2007-05-22 12:23:20 EDT (Tue, 22 May 2007)
@@ -6,8 +6,8 @@
$template_start$
$template_cpp_copyright$
-#ifndef BOOST_$TEMPLATE_LIBRARY$_$TEMPLATE_LIBRARY$_HPP
-#define BOOST_$TEMPLATE_LIBRARY$_$TEMPLATE_LIBRARY$_HPP
+#ifndef BOOST_$template_LIBRARY$_$template_LIBRARY$_HPP
+#define BOOST_$template_LIBRARY$_$template_LIBRARY$_HPP
namespace boost {
namespace $template_library$ {
@@ -80,5 +80,5 @@
} // namespace $template_library$
} // namespace boost
-#endif // BOOST_$TEMPLATE_LIBRARY$_$TEMPLATE_LIBRARY$_HPP
+#endif // BOOST_$template_LIBRARY$_$template_LIBRARY$_HPP
Deleted: /sandbox/template_under_construction/$template_library$/boost/_library_/_library_.hpp
==============================================================================
--- /sandbox/template_under_construction/$template_library$/boost/_library_/_library_.hpp 2007-05-22 12:23:20 EDT (Tue, 22 May 2007)
+++ (empty file)
@@ -1,84 +0,0 @@
-// Copyright 2007 Stjepan Rajko.
-// Distributed under the Boost Software License, Version 1.0.
-// (See accompanying file LICENSE_1_0.txt or copy at
-// http://www.boost.org/LICENSE_1_0.txt)_cpp_copyright_
-
-$template_start$
-$template_cpp_copyright$
-
-#ifndef BOOST_$TEMPLATE_LIBRARY$_$TEMPLATE_LIBRARY$_HPP
-#define BOOST_$TEMPLATE_LIBRARY$_$TEMPLATE_LIBRARY$_HPP
-
-namespace boost {
-namespace $template_library$ {
-
-/// The $template_library$ class does nothing.
-/** \ingroup group_nothing
- \param T The type on which $template_library$ does nothing.
- \warning This class does nothing.
- \todo Make this class do something.
- \bug This class does do something.
-
- Since $template_library$ does nothing, it is not very useful.
-*/
-template<typename T
-#ifndef DOXYGEN_DOCS_ONLY
- , typename Enable=void // maybe documentation doesn't need to know about this.
-#endif
->
-class $template_library$
-{
-public:
- /// Default constructor.
- /** This constructor actually does something. It sets the internal
- counters to 0.
- */
- $template_library$() : nothing_count(0), call_count(0) {}
-
- /// This function does nothing with the passed parameter.
- void nothing(T t)
- {
- nothing_count++;
- call_count++;
- }
-
- /// This function does nothing with the passed parameter a specified number of times.
- /** \param n Number of times nothing is done.
-
- This function is equivalent to calling nothing n times.
- */
- void nothing(T t, unsigned n)
- {
- call_count++;
- for (unsigned i=0; i<n; i++)
- nothing(t);
- call_count-=n;
- }
-
- /// This function can be used to determine how many times nothing has been done.
- /** \returns count of how many times nothing has been done.
- */
- int get_nothing_count()
- {
- return nothing_count;
- }
- /// This function can be used to determine how many calls have been made to the object.
- /** \returns count of how many times a method of this object has been called by the user.
- */
- int get_call_count()
- {
- return call_count;
- }
-protected:
- /// The number of times this object did nothing.
- int nothing_count;
-private:
- // Number of times the member function was called.
- int call_count;
-};
-
-} // namespace $template_library$
-} // namespace boost
-
-#endif // BOOST_$TEMPLATE_LIBRARY$_$TEMPLATE_LIBRARY$_HPP
-
Deleted: sandbox/template_under_construction/$template_library$/boost/_library_.hpp
==============================================================================
--- sandbox/template_under_construction/$template_library$/boost/_library_.hpp 2007-05-22 12:23:20 EDT (Tue, 22 May 2007)
+++ (empty file)
@@ -1,15 +0,0 @@
-// Copyright 2007 Stjepan Rajko.
-// Distributed under the Boost Software License, Version 1.0.
-// (See accompanying file LICENSE_1_0.txt or copy at
-// http://www.boost.org/LICENSE_1_0.txt)
-
-$template_start$
-$template_cpp_copyright$
-
-#ifndef BOOST_$TEMPLATE_LIBRARY$_HPP
-#define BOOST_$TEMPLATE_LIBRARY$_HPP
-
-#include <boost/$template_library$/$template_library$.hpp>
-
-#endif // BOOST_$TEMPLATE_LIBRARY$_HPP
-
Copied: sandbox/template_under_construction/$template_library$/libs/$template_library$/doc/$template_library$.qbk (from r4178, /sandbox/template_under_construction/$template_library$/libs/$template_library$/doc/_library_.qbk)
==============================================================================
--- /sandbox/template_under_construction/$template_library$/libs/$template_library$/doc/_library_.qbk (original)
+++ sandbox/template_under_construction/$template_library$/libs/$template_library$/doc/$template_library$.qbk 2007-05-22 12:23:20 EDT (Tue, 22 May 2007)
@@ -7,8 +7,8 @@
[library $template_library$
[quickbook 1.4]
[version 0.1]
- [authors _author_reversed_]
- [copyright _year_ _author_]
+ [authors $template_author_reversed$]
+ [copyright $template_year$ $template_author$]
[purpose Boost Sandbox Template]
[license
Distributed under the Boost Software License, Version 1.0.
@@ -20,7 +20,7 @@
[section:overview Overview]
[warning $template_Library$ is in very early stages of development. At this point, it is likely
-NOT a good starting point for a boost sandbox project. The templates it generates have
+[*not] a good starting point for a boost sandbox project. The templates it generates have
not been verified for adherence to Boost guidelines, and do some things that are
inconsistent with current practices.]
@@ -117,28 +117,26 @@
The following substitutions are defined on files of extensions '.hpp', '.cpp', '.v2', '.jam', '.qbk', '.vcproj', '.sln':
[table Substitutions used by $template_library$
[[substitution template][substituted text]]
- [[\_boost\_library\_][The full Boost.Library name of the library]]
- [[\_library\_][The library name specified by the user]]
- [[\_Library\_][Capitalized library name]]
- [[\_LIBRARY\_][Uppercase library name]]
- [[\_python\_copyright\_][Python-style commented copyright block]]
- [[\_cpp\_copyright\_][C++-style commented copyright block]]
- [[\_qbk\_copyright\_][Copyright block with quickbook-style link]]
- [[\_author\_reversed\_][Bracketed list of authors, last name first]]
- [[\_author\_][list of authors, as specified by the user]]
- [[\_year\_][Current year]]
- [[\_msvc\_build\_uuid\_][Randomly generated UUID for MSVC build project]]
- [[\_msvc\_doc\_uuid\_][Randomly generated UUID for MSVC doc project]]
- [[\_msvc\_example\_uuid\_][Randomly generated UUID for MSVC example project]]
- [[\_msvc\_test\_uuid\_][Randomly generated UUID for MSVC test project]]
- [[\_msvc\_build\_command\_][bjam build commands used in MSVC projects]]
+ [[$template\_boost\_library$][The full Boost.Library name of the library]]
+ [[$template\_library$][The library name specified by the user]]
+ [[$template\_Library$][Capitalized library name]]
+ [[$template\_LIBRARY$][Uppercase library name]]
+ [[$template\_python\_copyright$][Python-style commented copyright block]]
+ [[$template\_cpp\_copyright$][C++-style commented copyright block]]
+ [[$template\_qbk\_copyright$][Copyright block with quickbook-style link]]
+ [[$template\_author\_reversed$][Bracketed list of authors, last name first]]
+ [[$template\_author$][list of authors, as specified by the user]]
+ [[$template\_year$][Current year]]
+ [[$template\_msvc\_build\_uuid$][Randomly generated UUID for MSVC build project]]
+ [[$template\_msvc\_doc\_uuid$][Randomly generated UUID for MSVC doc project]]
+ [[$template\_msvc\_example\_uuid$][Randomly generated UUID for MSVC example project]]
+ [[$template\_msvc\_test\_uuid$][Randomly generated UUID for MSVC test project]]
+ [[$template\_msvc\_build\_command$][bjam build commands used in MSVC projects]]
]
-[important The substitutions are applied exactly in the order specified, so
+[tip The substitutions are applied exactly in the order specified, so
substituted text can include substitution templates occuring later in the table
-(e.g., \_cpp\_copyright\_ expands into text which includes \_author\_). Also,
-it is likely a [*bad idea] to introduce a substitution template which is substring of a [*later]
-substitution template.]
+(e.g., $template\_cpp\_copyright$ expands into text which includes $template\_author$).]
[endsect]
Deleted: sandbox/template_under_construction/$template_library$/libs/$template_library$/doc/_library_.qbk
==============================================================================
--- sandbox/template_under_construction/$template_library$/libs/$template_library$/doc/_library_.qbk 2007-05-22 12:23:20 EDT (Tue, 22 May 2007)
+++ (empty file)
@@ -1,161 +0,0 @@
-[/ Copyright 2007 Stjepan Rajko. ]
-[/ Distributed under the Boost Software License, Version 1.0. ]
-[/ (See accompanying file LICENSE_1_0.txt or copy at ]
-[/ http://www.boost.org/LICENSE_1_0.txt) ]
-
-$template_start$
-[library $template_library$
- [quickbook 1.4]
- [version 0.1]
- [authors _author_reversed_]
- [copyright _year_ _author_]
- [purpose Boost Sandbox Template]
- [license
- Distributed under the Boost Software License, Version 1.0.
- (See accompanying file LICENSE_1_0.txt or copy at
- [@http://www.boost.org/LICENSE_1_0.txt])
- ]
-]
-
-[section:overview Overview]
-
-[warning $template_Library$ is in very early stages of development. At this point, it is likely
-NOT a good starting point for a boost sandbox project. The templates it generates have
-not been verified for adherence to Boost guidelines, and do some things that are
-inconsistent with current practices.]
-
-[section:introduction Introduction]
-
-$template_Library$ is template for Boost sandbox projects. Given some information about the project
-(e.g., library name and author), it will generate the following:
-* a directory tree for the library
-* commonly used source, documentation and build files
-* projects for several IDEs (currently MSVC, with Xcode in the works)
-
-The content in the generated project contains this documentation, which describes how
-to use the template, and an implementation of a [classref boost::$template_library$::$template_library$
-class which does nothing].
-
-[endsect]
-
-[section:start Getting Started]
-To use the project created by $template_library$ fully, you will need a few things.
-
-[important Some parts of $template_library$ will not work with versions of Boost other than CVS HEAD]
-First of all, you should familiarize yourself with Boost. A good starting point for this
-is [@http://www.boost.org/more/getting_started/index.html the getting started page].
-In particular, make sure you have installed a recent version of Boost, and have a working
-bjam executable.
-
-Second, you will need to download some additional tools to build the documentation.
-Instructions for this part can be found in the [@http://www.boost.org/doc/html/boostbook.html
-Boostbook documentation]. The projects generated by $template_library$ rely on xsltproc,
-DocBook XSL and DTD distributions, and Doxygen. $template_library$ does not currently use
-Apache FOP.
-
-Finally, you will need access to the sandbox in the
-[@http://svn.boost.org/trac/boost/wiki/BoostSubversion Boost subversion]. Follow
-the directions in the [@http://svn.boost.org/trac/boost/wiki/BoostSubversion Boost subversion wiki].
-
-Once you have all this in place, go to the template-under-construction folder of the sandbox.
-Run the make_template.py script, and follow the instructions. For example,
-the project used to build this documentation was created as follows:
-
-[python]
-
- >>> import make_template
- library name: (e.g., something_new): sandbox_template
- library author[s]: (e.g., Yours Truly[,Yours D. NotTruly]): Stjepan Rajko
-
-Some other information that might come in handy as you start working on your project:
-
-* [@http://www.boost.org/more/lib_guide.htm#Directory_structure Boost library directory structure]
-* [@http://www.stack.nl/~dimitri/doxygen/commands.html Doxygen command reference]
-* [@http://www.boost-consulting.com/boost/tools/quickbook/doc/html/index.html Quickbook reference]
-
-[endsect]
-
-
-[section:bugs Known Bugs]
-
-[endsect]
-
-[section:license License]
-
-$template_qbk_copyright$
-
-[endsect]
-
-[endsect]
-
-[section:doxygen Doxygen Documentation]
-When Doxygen documentation is used with Boostbook, as far as I can tell
-only certain elements of the Doxygen documentation (such as class and function reference) can
-be included into the main documentation. Other documentation generated by Doxygen (main and
-related pages, todo and bug lists, modules...) does not seem to be available. The rationale
-for this, AFAICR from a list discussion e-mail I can't find any more, is to make the generated
-documentation close to a C++ standard proposal (but I might be way off here).
-
-However, it is possible to have Doxygen create its own HTML output and [@../doxygen/index.html link]
-to it from the main documentation. While this will include everything Doxygen is configured
-to generate, please note that this is inconsistent with the documentation layouts of
-most recent Boost libraries.
-
-In any case, it is probaby unwise to include both the
-[@../doxygen/index.html verbatim generated Doxygen documentation] and the
-[link $template_library$.reference reference], which is what happens how. $template_Library$
-should provide some options / alternatives.
-
-[endsect]
-
-[section:editing Editing the Templates]
-
-The template script is currently a very simple file relocator / processor. It copies
-a template directory tree into a new location, renaming files where applicable
-and substituting the contents where specified.
-
-The following substitutions are defined on files of extensions '.hpp', '.cpp', '.v2', '.jam', '.qbk', '.vcproj', '.sln':
-[table Substitutions used by $template_library$
- [[substitution template][substituted text]]
- [[\_boost\_library\_][The full Boost.Library name of the library]]
- [[\_library\_][The library name specified by the user]]
- [[\_Library\_][Capitalized library name]]
- [[\_LIBRARY\_][Uppercase library name]]
- [[\_python\_copyright\_][Python-style commented copyright block]]
- [[\_cpp\_copyright\_][C++-style commented copyright block]]
- [[\_qbk\_copyright\_][Copyright block with quickbook-style link]]
- [[\_author\_reversed\_][Bracketed list of authors, last name first]]
- [[\_author\_][list of authors, as specified by the user]]
- [[\_year\_][Current year]]
- [[\_msvc\_build\_uuid\_][Randomly generated UUID for MSVC build project]]
- [[\_msvc\_doc\_uuid\_][Randomly generated UUID for MSVC doc project]]
- [[\_msvc\_example\_uuid\_][Randomly generated UUID for MSVC example project]]
- [[\_msvc\_test\_uuid\_][Randomly generated UUID for MSVC test project]]
- [[\_msvc\_build\_command\_][bjam build commands used in MSVC projects]]
-]
-
-[important The substitutions are applied exactly in the order specified, so
-substituted text can include substitution templates occuring later in the table
-(e.g., \_cpp\_copyright\_ expands into text which includes \_author\_). Also,
-it is likely a [*bad idea] to introduce a substitution template which is substring of a [*later]
-substitution template.]
-
-[endsect]
-
-[section:examples Documentation Examples]
-This section has some examples of what you can do with documentation. Refer to the source.
-
-[section:examples_inserting_code Inserting Code]
-
-Here is some code directly from an example:
-
-[c++]
-
-[import ../example/example.cpp]
-[$template_library$_example]
-
-[endsect]
-
-[endsect]
-
-[xinclude $template_library$_doxygen.xml]
\ No newline at end of file
Copied: sandbox/template_under_construction/$template_library$/libs/$template_library$/doc/dox/$template_library$.hpp (from r4178, /sandbox/template_under_construction/$template_library$/libs/$template_library$/doc/dox/_library_.hpp)
==============================================================================
--- /sandbox/template_under_construction/$template_library$/libs/$template_library$/doc/dox/_library_.hpp (original)
+++ sandbox/template_under_construction/$template_library$/libs/$template_library$/doc/dox/$template_library$.hpp 2007-05-22 12:23:20 EDT (Tue, 22 May 2007)
@@ -4,6 +4,8 @@
// http://www.boost.org/LICENSE_1_0.txt)_cpp_copyright_
$template_start$
+$template_cpp_copyright$
+
namespace boost {
/** \mainpage
Deleted: sandbox/template_under_construction/$template_library$/libs/$template_library$/doc/dox/_library_.hpp
==============================================================================
--- sandbox/template_under_construction/$template_library$/libs/$template_library$/doc/dox/_library_.hpp 2007-05-22 12:23:20 EDT (Tue, 22 May 2007)
+++ (empty file)
@@ -1,25 +0,0 @@
-// Copyright 2007 Stjepan Rajko.
-// Distributed under the Boost Software License, Version 1.0.
-// (See accompanying file LICENSE_1_0.txt or copy at
-// http://www.boost.org/LICENSE_1_0.txt)_cpp_copyright_
-
-$template_start$
-namespace boost {
-
-/** \mainpage
-
-This is generated by doxygen directly.
-
-It includes things such as a \ref page_related, modules/groups, automatically
-generated \ref todo and \ref bug.
-*/
-
-/** \page page_related Related Page
-This is a doxygen related page.
-*/
-
-/** \defgroup group_nothing Classes that do nothing.
-This group contains classes that do nothing.
-*/
-
-}
\ No newline at end of file
Deleted: sandbox/template_under_construction/$template_library$/libs/$template_library$/vc8ide/_library_.sln
==============================================================================
--- sandbox/template_under_construction/$template_library$/libs/$template_library$/vc8ide/_library_.sln 2007-05-22 12:23:20 EDT (Tue, 22 May 2007)
+++ (empty file)
@@ -1,37 +0,0 @@
-Microsoft Visual Studio Solution File, Format Version 9.00
-# Visual Studio 2005
-Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "build", "build.vcproj", "{$template_msvc_build_uuid$}"
-EndProject
-Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "doc", "doc.vcproj", "{$template_msvc_doc_uuid_}"
-EndProject
-Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "example", "example.vcproj", "{$template_msvc_example_uuid_}"
-EndProject
-Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "test", "test.vcproj", "{$template_msvc_test_uuid_}"
-EndProject
-Global
- GlobalSection(SolutionConfigurationPlatforms) = preSolution
- debug|Win32 = debug|Win32
- release|Win32 = release|Win32
- EndGlobalSection
- GlobalSection(ProjectConfigurationPlatforms) = postSolution
- {$template_msvc_build_uuid$}.debug|Win32.ActiveCfg = debug|Win32
- {$template_msvc_build_uuid$}.debug|Win32.Build.0 = debug|Win32
- {$template_msvc_build_uuid$}.release|Win32.ActiveCfg = release|Win32
- {$template_msvc_build_uuid$}.release|Win32.Build.0 = release|Win32
- {$template_msvc_doc_uuid$}.debug|Win32.ActiveCfg = release|Win32
- {$template_msvc_doc_uuid$}.debug|Win32.Build.0 = release|Win32
- {$template_msvc_doc_uuid$}.release|Win32.ActiveCfg = release|Win32
- {$template_msvc_doc_uuid$}.release|Win32.Build.0 = release|Win32
- {$template_msvc_example_uuid$}.debug|Win32.ActiveCfg = debug|Win32
- {$template_msvc_example_uuid$}.debug|Win32.Build.0 = debug|Win32
- {$template_msvc_example_uuid$}.release|Win32.ActiveCfg = release|Win32
- {$template_msvc_example_uuid$}.release|Win32.Build.0 = release|Win32
- {$template_msvc_test_uuid$}.debug|Win32.ActiveCfg = debug|Win32
- {$template_msvc_test_uuid$}.debug|Win32.Build.0 = debug|Win32
- {$template_msvc_test_uuid$}.release|Win32.ActiveCfg = release|Win32
- {$template_msvc_test_uuid$}.release|Win32.Build.0 = release|Win32
- EndGlobalSection
- GlobalSection(SolutionProperties) = preSolution
- HideSolutionNode = FALSE
- EndGlobalSection
-EndGlobal
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