bodewig 02/05/21 06:32:29
Modified: proposal/gump/site/xdocs project.xml
Log:
Share secret <javadoc> knowledge.
Revision Changes Path
1.11 +85 -2 jakarta-alexandria/proposal/gump/site/xdocs/project.xml
Index: project.xml
===================================================================
RCS file: /home/cvs/jakarta-alexandria/proposal/gump/site/xdocs/project.xml,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- project.xml 2 Apr 2002 12:58:04 -0000 1.10
+++ project.xml 21 May 2002 13:32:29 -0000 1.11
@@ -288,11 +288,94 @@
</tr>
<tr>
<td>nested</td>
- <td>Name of a directory or file, relative to the srcdir of the module
- containing this project.</td>
+ <td>Name of a directory or file, relative to the srcdir of
+ the module containing this project. <b>Note that this
+ ignores any <a href="#home"><home></a>
+ settings.</b></td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>parent</td>
+ <td>Name of a directory or file, relative to the base directory
+ of the workspace.</td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>project</td>
+ <td>Label to use in the javadoc listing (see below). Default
+ is the name of the project.</td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>module</td>
+ <td>Make the entry for this project in the javadoc listing
+ (see below) appear under the named instead of the enclosing
+ module.</td>
<td>No</td>
</tr>
</table>
+
+ <p><javadoc> supports a nested <description>
+ element, which can be used to set the title in the javadoc
+ listing. If no <description> element has been specified,
+ the title defaults to the description of the
+ project. <description> itself only supports nested
+ text and an optional dir attribute.</p>
+
+ <p>The <javadoc> elements of all projects are used to
+ create two pages, "javadoc.html" (like
+ <a href="http://nagoya.apache.org/~rubys/gump/javadoc.html";>this</a>)
+ and "nojavadoc.html" (like
+ <a href="http://nagoya.apache.org/~rubys/gump/nojavadoc.html";>this</a>)
+ listing the available sets of documentation and the modules
+ without documentation.</p>
+
+ <p>There are three different layouts a <javadoc> element
+ may create in the javadoc listing "javadoc.html":</p>
+
+ <ol>
+ <li>This is the only <javadoc> element associated with
+ the module, the result will look like<br/><br/>
+ <a href="#">label</a> - description<br/><br/></li>
+
+ <li>There are several <javadoc> elements associated with
+ the module, their labels are different from the name of the
+ module - the result will look like<br/><br/>
+ <b>name of the module</b> - description of the module
+ <blockquote>
+ <a href="#">label</a> - description<br/>
+ <a href="#">label2</a> - description2<br/>
+ </blockquote></li>
+
+ <li>There are several <javadoc> elements associated with
+ the module, their labels are all the same as the name of the
+ module - the result will look like<br/><br/>
+ <b>name of the module</b> - description of the module
+ <blockquote>
+ <a href="#">description</a><br/>
+ <a href="#">description2</a><br/>
+ </blockquote></li>
+
+ </ol>
+
+ <p><em>label</em> in this lists will be created from the project
+ attribute and <em>description</em> from the description child
+ element of <javadoc></p>
+
+ <p>If a given project wants to publish more than one javadoc
+ set, multiple <description> elements like in</p>
+
+ <source><![CDATA[
+ <javadoc nested="java/build/docs/javadocs" project="xml-xerces2">
+ <description dir="api">XML Standard API</description>
+ <description dir="xni">Xerces Native Interface</description>
+ <description dir="xerces">Xerces2 Implementation</description>
+ <description dir="other">Other Classes</description>
+ </javadoc>
+]]></source>
+
+ <p>must be used.</p>
+
</subsection>
<subsection name="nag">
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
