[Boost-commit] svn:boost r77781 - trunk/tools/build/v2/doc/src

Subject: [Boost-commit] svn:boost r77781 - trunk/tools/build/v2/doc/src
From: steven_at_[hidden]
Date: 2012-04-05 10:41:48

Author: steven_watanabe
Date: 2012-04-05 10:41:47 EDT (Thu, 05 Apr 2012)
New Revision: 77781
URL: http://svn.boost.org/trac/boost/changeset/77781

Log:
Add a synopsis to abstract-target
Text files modified: 
   trunk/tools/build/v2/doc/src/abstract-target.xml |    27 +++++++++++++++++++--------             
   1 files changed, 19 insertions(+), 8 deletions(-)

Modified: trunk/tools/build/v2/doc/src/abstract-target.xml
==============================================================================
--- trunk/tools/build/v2/doc/src/abstract-target.xml	(original)
+++ trunk/tools/build/v2/doc/src/abstract-target.xml	2012-04-05 10:41:47 EDT (Thu, 05 Apr 2012)
@@ -13,6 +13,17 @@
     Base class for all abstract targets.
   </para>
 
+<programlisting language="jam">
+class abstract-target {
+    rule <link linkend="bbv2.reference.class.abstract-target.__init__">__init__</link> ( name : project )
+    rule <link linkend="bbv2.reference.class.abstract-target.name">name</link> ( )
+    rule <link linkend="bbv2.reference.class.abstract-target.project">project</link> ( )
+    rule <link linkend="bbv2.reference.class.abstract-target.location">location</link> ( )
+    rule <link linkend="bbv2.reference.class.abstract-target.full-name">full-name</link> ( )
+    rule <link linkend="bbv2.reference.class.abstract-target.__init__">generate</link> ( property-set )
+}
+</programlisting>
+
   <para>
     Classes derived from <link linkend="bbv2.reference.class.abstract-target">abstract-target</link>:
     <itemizedlist>
@@ -31,19 +42,19 @@
   <orderedlist>
     
     <listitem id="bbv2.reference.class.abstract-target.__init__">
-      <code language="jam">rule __init__ ( name : project-target )</code>
+      <code language="jam">rule __init__ ( name : project )</code>
       <para>
         <variablelist>
           <varlistentry>
-            <literal>name</literal>
+            <term><literal>name</literal></term>
             <listitem>
-              <para>Name of the target in Jamfile.</para>
+              <para>The name of the target in the Jamfile.</para>
             </listitem>
-          </varlistentry>          
+          </varlistentry>
           <varlistentry>
-            <literal>project-target</literal>
+            <term><literal>project</literal></term>
             <listitem>
-              <para>The project target to which this one belongs.</para>
+              <para>The <link linkend="bbv2.reference.class.project-target">project</link> to which this target belongs.</para>
             </listitem>
           </varlistentry>
         </variablelist>
@@ -65,7 +76,7 @@
         <secondary>Abstract Target</secondary>
       </indexterm>
       <code language="jam">rule project ( )</code>
-      <para>Returns the project for this target.</para>
+      <para>Returns the <link linkend="bbv2.reference.class.project-target">project</link> for this target.</para>
     </listitem>
 
     <listitem id="bbv2.reference.class.abstract-target.location">
@@ -74,7 +85,7 @@
         <secondary>Abstract Target</secondary>
       </indexterm>
       <code language="jam">rule location ( )</code>
-      <para>Return the location where the target was declared.</para>
+      <para>Returns the location where the target was declared.</para>
     </listitem>
 
     <listitem id="bbv2.reference.class.abstract-target.full-name">