svn commit: r376857 - in /maven/maven-1/plugins/trunk/xdoc/xdocs: changes.xml properties.xml

Fri, 10 Feb 2006 13:20:58 -0800 

Author: ltheussl
Date: Fri Feb 10 13:11:54 2006
New Revision: 376857

URL: http://svn.apache.org/viewcvs?rev=376857&view=rev
Log:
PR:MPXDOC-189
Document the use of pom settings by the xdoc plugin.

Modified:
    maven/maven-1/plugins/trunk/xdoc/xdocs/changes.xml
    maven/maven-1/plugins/trunk/xdoc/xdocs/properties.xml

Modified: maven/maven-1/plugins/trunk/xdoc/xdocs/changes.xml
URL: 
http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/xdoc/xdocs/changes.xml?rev=376857&r1=376856&r2=376857&view=diff
==============================================================================
--- maven/maven-1/plugins/trunk/xdoc/xdocs/changes.xml (original)
+++ maven/maven-1/plugins/trunk/xdoc/xdocs/changes.xml Fri Feb 10 13:11:54 2006
@@ -27,6 +27,7 @@
   </properties>
   <body>
     <release version="1.10-SNAPSHOT" date="in SVN">
+      <action dev="ltheussl" type="add" issue="MPXDOC-189">Document the use of 
pom settings by the xdoc plugin.</action>
       <action dev="ltheussl" type="fix" issue="MPXDOC-130">CVS usage page is 
blank when using Subversion.</action>
       <action dev="ltheussl" type="fix" issue="MPXDOC-185">Fix broken 
<code>maven.xdoc.date=navigation-top</code> and 
<code>navigation-bottom</code>.</action>
       <action dev="ltheussl" type="add" issue="MPXDOC-183" due-to="Niall 
Pemberton">Enable user-defined custom templates.</action>

Modified: maven/maven-1/plugins/trunk/xdoc/xdocs/properties.xml
URL: 
http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/xdoc/xdocs/properties.xml?rev=376857&r1=376856&r2=376857&view=diff
==============================================================================
--- maven/maven-1/plugins/trunk/xdoc/xdocs/properties.xml (original)
+++ maven/maven-1/plugins/trunk/xdoc/xdocs/properties.xml Fri Feb 10 13:11:54 
2006
@@ -738,5 +738,40 @@
         -->
       </table>
     </section>
+
+    <section name="Pom Settings">
+      <p>
+        The <code>Project Info</code> pull-down menu uses several settings
+        of your <code>project.xml</code> file for generating the pages:
+      </p>
+      <p>
+        The contents of the
+        <a 
href="http://maven.apache.org/maven-1.x/reference/project-descriptor.html#class_MailingList";><code>&lt;mailingList&gt;</code></a>
+        elements are used in the <code>Mailing Lists</code> page.
+      </p>
+      <p>
+        The contents of the
+        <a 
href="http://maven.apache.org/maven-1.x/reference/project-descriptor.html#class_Developer";><code>&lt;developer&gt;</code></a>
+        and
+        <a 
href="http://maven.apache.org/maven-1.x/reference/project-descriptor.html#class_Contributor";><code>&lt;contributor&gt;</code></a>
+        elements are used in the <code>Project Team</code> page.
+      </p>
+      <p>
+        The contents of the
+        <a 
href="http://maven.apache.org/maven-1.x/reference/project-descriptor.html#class_Dependency";><code>&lt;dependency&gt;</code></a>
+        element are used in the <code>Dependencies</code> page.
+        Note in particular that the optional <code>comment</code> is generated 
by a
+        <code>&lt;comment&gt;</code> element in the 
<code>&lt;properties&gt;</code> section.
+      </p>
+      <p>
+        The contents of the
+        <a 
href="http://maven.apache.org/maven-1.x/reference/project-descriptor.html#class_Repository";><code>&lt;repository&gt;</code></a>
+        elements are used in the <code>Source Repository</code> page.
+      </p>
+      <p>
+        The &lt;issueTrackingUrl/&gt; element is used in the <code>Issue 
Tracking</code> page.
+      </p>
+    </section>
+
   </body>
 </document>

Reply via email to