|
Boost-Commit : |
From: jurko.gospodnetic_at_[hidden]
Date: 2008-01-15 16:13:52
Author: jurko
Date: 2008-01-15 16:13:52 EST (Tue, 15 Jan 2008)
New Revision: 42801
URL: http://svn.boost.org/trac/boost/changeset/42801
Log:
Minor stylistic comment changes. Removed trailing spaces.
Text files modified:
trunk/tools/build/v2/util/doc.jam | 54 ++++++++++++++++++++--------------------
1 files changed, 27 insertions(+), 27 deletions(-)
Modified: trunk/tools/build/v2/util/doc.jam
==============================================================================
--- trunk/tools/build/v2/util/doc.jam (original)
+++ trunk/tools/build/v2/util/doc.jam 2008-01-15 16:13:52 EST (Tue, 15 Jan 2008)
@@ -1,13 +1,13 @@
-# Copyright 2002, 2005 Dave Abrahams
-# Copyright 2002, 2003, 2006 Rene Rivera
-# Copyright 2003 Vladimir Prus
-# Distributed under the Boost Software License, Version 1.0.
-# (See accompanying file LICENSE_1_0.txt or http://www.boost.org/LICENSE_1_0.txt)
+# Copyright 2002, 2005 Dave Abrahams
+# Copyright 2002, 2003, 2006 Rene Rivera
+# Copyright 2003 Vladimir Prus
+# Distributed under the Boost Software License, Version 1.0.
+# (See accompanying file LICENSE_1_0.txt or http://www.boost.org/LICENSE_1_0.txt)
# Documentation system, handles --help requests.
# It defines rules that attach documentation to modules, rules, and variables.
-# Collects and generates documentation for the various parts of the build system.
-# The documentation is collected from comments integrated into the code.
+# Collects and generates documentation for the various parts of the build
+# system. The documentation is collected from comments integrated into the code.
import modules ;
import print ;
@@ -235,17 +235,17 @@
# Generates a general description of the documentation and help system.
#
local rule print-help-top ( )
-{
+{
print.section "General command line usage" ;
print.text " bjam [options] [properties] [targets]
-
+
Options, properties and targets can be specified in any order.
" ;
-
- print.section "Important Options" ;
-
- print.list-start ;
+
+ print.section "Important Options" ;
+
+ print.list-start ;
print.list-item "--clean Remove targets instead of building" ;
print.list-item "-a Rebuild everything" ;
print.list-item "-n Don't execute the commands, only print them" ;
@@ -256,11 +256,11 @@
print.list-item "--debug-building Report which targets are built with what properties" ;
print.list-item "--debug-generator Diagnose generator search/execution" ;
print.list-end ;
-
+
print.section "Further Help"
The following options can be used to obtain additional documentation.
;
-
+
print.list-start ;
print.list-item "--help-options Print more obscure command line options." ;
print.list-item "--help-internal Boost.Build implementation details." ;
@@ -410,11 +410,11 @@
}
}
-# Generate documentation for possible modules. We attempt to list all known
-# modules, and a brief description of each.
+# Generate documentation for all possible modules. We attempt to list all known
+# modules together with a brief description of each.
#
local rule print-help-all (
- ignored # Usually the module name, but is ignored here.
+ ignored # Usually the module name, but is ignored here.
)
{
print.section "Modules"
@@ -451,19 +451,19 @@
{
# Print the docs.
print.section "Module '$(module-name)'" $($(module-name).docs) ;
-
+
# Print out the documented classes.
print-help-module-section $(module-name) classes : "Module '$(module-name)' classes"
Use --help $(module-name).<class-name> to get more information. ;
-
+
# Print out the documented rules.
print-help-module-section $(module-name) rules : "Module '$(module-name)' rules"
Use --help $(module-name).<rule-name> to get more information. ;
-
+
# Print out the documented variables.
print-help-module-section $(module-name) variables : "Module '$(module-name)' variables"
Use --help $(module-name).<variable-name> to get more information. ;
-
+
# Print out all the same information but indetailed form.
if $(.option.detailed)
{
@@ -536,11 +536,11 @@
print.list-end ;
}
}
-
+
# Print out the documented rules of the class.
print-help-module-section $(module-name) $(class-name).class-rules : "Class '$(module-name).$(class-name)' rules"
Use --help $(module-name).<rule-name> to get more information. ;
-
+
# Print out all the rules if details are requested.
if $(.option.detailed)
{
@@ -594,7 +594,7 @@
# Print the docs.
print.section "Project-specific help"
Project has jamfile at $(jamfile) ;
-
+
print.lines $(jamfile<$(jamfile)>.docs) "" ;
}
}
@@ -612,7 +612,7 @@
# Print the docs.
print.section "Configuration help"
Configuration file at $(config-file) ;
-
+
print.lines $(jamfile<$(config-file)>.docs) "" ;
}
}
@@ -738,7 +738,7 @@
scope-level = $(scope-level[2-]) ;
}
}
-
+
return true ;
}
}
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