Return-Path: Delivered-To: apmail-maven-commits-archive@www.apache.org Received: (qmail 40616 invoked from network); 18 Jul 2008 21:39:06 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2) by minotaur.apache.org with SMTP; 18 Jul 2008 21:39:06 -0000 Received: (qmail 74691 invoked by uid 500); 18 Jul 2008 21:39:06 -0000 Delivered-To: apmail-maven-commits-archive@maven.apache.org Received: (qmail 74624 invoked by uid 500); 18 Jul 2008 21:39:06 -0000 Mailing-List: contact commits-help@maven.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@maven.apache.org Delivered-To: mailing list commits@maven.apache.org Received: (qmail 74615 invoked by uid 99); 18 Jul 2008 21:39:06 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 18 Jul 2008 14:39:06 -0700 X-ASF-Spam-Status: No, hits=-2000.0 required=10.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 18 Jul 2008 21:38:12 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id 2937523889C2; Fri, 18 Jul 2008 14:38:02 -0700 (PDT) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r678048 - in /maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc: AbstractJavadocMojo.java JavadocJar.java JavadocReport.java TestJavadocJar.java TestJavadocReport.java Date: Fri, 18 Jul 2008 21:38:01 -0000 To: commits@maven.apache.org From: vsiveton@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20080718213802.2937523889C2@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: vsiveton Date: Fri Jul 18 14:38:01 2008 New Revision: 678048 URL: http://svn.apache.org/viewvc?rev=678048&view=rev Log: o improved javadoc (workaround for MPLUGIN-128) Modified: maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestJavadocJar.java maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestJavadocReport.java Modified: maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java?rev=678048&r1=678047&r2=678048&view=diff ============================================================================== --- maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java (original) +++ maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java Fri Jul 18 14:38:01 2008 @@ -252,6 +252,7 @@ * <additionalJOption>-J-Xss128m</additionalJOption> * * See Jflag. + *
* See vmoptions. * * @since 2.3 @@ -304,6 +305,7 @@ /** * Whether to build an aggregated report at the root, or build individual reports. * Since 2.5, you could use javadoc:aggregate goal as an alternative. + *
* * @parameter expression="${aggregate}" default-value="false" */ @@ -311,6 +313,7 @@ /** * Set this to 'true' to debug Javadoc plugin. With this, 'options' and 'files' files are provided. + *
* * @since 2.1 * @parameter expression="${debug}" default-value="false" @@ -338,6 +341,7 @@ /** * Specifies whether the javadoc generation should be skipped + *
* * @since 2.5 * @parameter expression="${maven.javadoc.skip}" default-value="false" @@ -354,6 +358,7 @@ * See breakiterator. *
* Since Java 1.4. + *
* * @parameter expression="${breakiterator}" default-value="false" */ @@ -426,6 +431,7 @@ *
* Note: In 2.4, the default value was locked to ISO-8859-1 to better reproducing build,but * this was reverted in 2.5. + *
* * @parameter expression="${encoding}" default-value="${project.build.sourceEncoding}" */ @@ -488,6 +494,7 @@ * Specifies the proxy host where the javadoc web access in -link would pass through. * It defaults to the proxy host of the active proxy set in the settings.xml, otherwise it gets the proxy * configuration set in the pom. + *
* * @parameter expression="${proxyHost}" default-value="${settings.activeProxy.host}" * @deprecated since 2.4. Instead of, configure an active proxy host in settings.xml. @@ -498,6 +505,7 @@ * Specifies the proxy port where the javadoc web access in -link would pass through. * It defaults to the proxy port of the active proxy set in the settings.xml, otherwise it gets the proxy * configuration set in the pom. + *
* * @parameter expression="${proxyPort}" default-value="${settings.activeProxy.port}" * @deprecated since 2.4. Instead of, configure an active proxy port in settings.xml. @@ -509,6 +517,7 @@ * Javadoc 1.1. *
* See 1.1. + *
* * @parameter expression="${old}" default-value="false" */ @@ -521,6 +530,7 @@ * Note: could be in conflict with <nooverview/>. *
* See overview. + *
* * @parameter expression="${overview}" default-value="${basedir}/src/main/javadoc/overview.html" */ @@ -539,6 +549,7 @@ *

private * (shows all classes and members)

* + *
* * @parameter expression="${show}" default-value="protected" */ @@ -554,6 +565,7 @@ * See quiet. *
* Since Java 5.0. + *
* * @parameter expression="${quiet}" default-value="false" */ @@ -596,6 +608,7 @@ * Provides more detailed messages while javadoc is running. *
* See verbose. + *
* * @parameter expression="${verbose}" default-value="false" */ @@ -609,6 +622,7 @@ * Specifies whether or not the author text is included in the generated Javadocs. *
* See author. + *
* * @parameter expression="${author}" default-value="true" */ @@ -620,6 +634,7 @@ * eg. <![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>]]> *
* See bottom. + *
* * @parameter expression="${bottom}" * default-value="Copyright © {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved." @@ -630,6 +645,7 @@ * Specifies the HTML character set for this document. *
* See charset. + *
* * @parameter expression="${charset}" default-value="ISO-8859-1" */ @@ -639,6 +655,7 @@ * Specifies the destination directory where javadoc saves the generated HTML files. *
* See d. + *
* * @parameter expression="${destDir}" alias="destDir" default-value="${project.build.directory}/apidocs" * @required @@ -651,6 +668,7 @@ * See docfilessubdirs. *
* Since Java 1.4. + *
* * @parameter expression="${docfilessubdirs}" default-value="false" */ @@ -669,6 +687,7 @@ * Specifies the title to be placed near the top of the overview summary file. *
* See doctitle. + *
* * @parameter expression="${doctitle}" default-value="${project.name} ${project.version} API" */ @@ -749,6 +768,7 @@ *
* Since * Java 5.0. + *
* * @since 2.1 * @parameter expression="${keywords}" default-value="false" @@ -791,6 +811,7 @@ * See linksource. *
* Since Java 1.4. + *
* * @parameter expression="${linksource}" default-value="false" */ @@ -802,6 +823,7 @@ * See nocomment. *
* Since Java 1.4. + *
* * @parameter expression="${nocomment}" default-value="false" */ @@ -811,6 +833,7 @@ * Prevents the generation of any deprecated API at all in the documentation. *
* See nodeprecated. + *
* * @parameter expression="${nodeprecated}" default-value="false" */ @@ -822,6 +845,7 @@ *
* See * nodeprecatedlist. + *
* * @parameter expression="${nodeprecatedlist}" default-value="false" */ @@ -833,6 +857,7 @@ * Note: could be in conflict with <helpfile/>. *
* See nohelp. + *
* * @parameter expression="${nohelp}" default-value="false" */ @@ -844,6 +869,7 @@ * Note: could be in conflict with <splitindex/>. *
* See noindex. + *
* * @parameter expression="${noindex}" default-value="false" */ @@ -853,6 +879,7 @@ * Omits the navigation bar from the generated docs. *
* See nonavbar. + *
* * @parameter expression="${nonavbar}" default-value="false" */ @@ -864,6 +891,7 @@ * Note: could be in conflict with <overview/>. *
* Standard Doclet undocumented option. + *
* * @since 2.4 * @parameter expression="${nooverview}" default-value="false" @@ -885,6 +913,7 @@ * Omits from the generated docs the "Since" sections associated with the since tags. *
* See nosince. + *
* * @parameter expression="${nosince}" default-value="false" */ @@ -897,6 +926,7 @@ *
* Since * Java 5.0. + *
* * @since 2.1 * @parameter expression="${notimestamp}" default-value="false" @@ -907,6 +937,7 @@ * Omits the class/interface hierarchy pages from the generated docs. *
* See notree. + *
* * @parameter expression="${notree}" default-value="false" */ @@ -927,6 +958,7 @@ * Generates compile-time warnings for missing serial tags. *
* See serialwarn + *
* * @parameter expression="${serialwarn}" default-value="false" */ @@ -956,6 +988,7 @@ * Note: could be in conflict with <noindex/>. *
* See splitindex. + *
* * @parameter expression="${splitindex}" default-value="false" */ @@ -964,6 +997,7 @@ /** * Specifies whether the stylesheet to be used is the maven javadoc stylesheet or java's default stylesheet * when a stylesheetfile parameter is not specified. Possible values: "maven" or "java". + *
* * @parameter expression="${stylesheet}" default-value="java" */ @@ -1087,6 +1121,7 @@ * Includes one "Use" page for each documented class and package. *
* See use. + *
* * @parameter expression="${use}" default-value="true" */ @@ -1096,6 +1131,7 @@ * Includes the version text in the generated docs. *
* See version. + *
* * @parameter expression="${version}" default-value="true" */ @@ -1105,6 +1141,7 @@ * Specifies the title to be placed in the HTML title tag. *
* See windowtitle. + *
* * @parameter expression="${windowtitle}" default-value="${project.name} ${project.version} API" */ Modified: maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java?rev=678048&r1=678047&r2=678048&view=diff ============================================================================== --- maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java (original) +++ maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java Fri Jul 18 14:38:01 2008 @@ -99,6 +99,7 @@ /** * Specifies whether to attach the generated artifact to the project helper. + *
* * @parameter expression="${attach}" default-value="true" */ @@ -126,6 +127,7 @@ /** * Set this to true to enable the use of the defaultManifestFile. + *
* * @parameter default-value="false" * @since 2.5 Modified: maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java?rev=678048&r1=678047&r2=678048&view=diff ============================================================================== --- maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java (original) +++ maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java Fri Jul 18 14:38:01 2008 @@ -64,6 +64,7 @@ /** * The name of the destination directory. + *
* * @since 2.1 * @parameter expression="${destDir}" default-value="apidocs" Modified: maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestJavadocJar.java URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestJavadocJar.java?rev=678048&r1=678047&r2=678048&view=diff ============================================================================== --- maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestJavadocJar.java (original) +++ maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestJavadocJar.java Fri Jul 18 14:38:01 2008 @@ -51,6 +51,7 @@ * Specifies the destination directory where javadoc saves the generated HTML files. *
* See d. + *
* * @parameter default-value="${project.build.directory}/testapidocs" * @required @@ -61,6 +62,7 @@ * Specifies the title to be placed near the top of the overview summary file. *
* See doctitle. + *
* * @parameter expression="${doctitle}" default-value="${project.name} ${project.version} Test API" */ @@ -71,6 +73,7 @@ * specified by path/filename and place it on the Overview page (overview-summary.html). *
* See overview. + *
* * @parameter expression="${overview}" default-value="${basedir}/src/test/javadoc/overview.html" */ @@ -80,6 +83,7 @@ * Specifies the title to be placed in the HTML title tag. *
* See windowtitle. + *
* * @parameter expression="${windowtitle}" default-value="${project.name} ${project.version} Test API" */ Modified: maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestJavadocReport.java URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestJavadocReport.java?rev=678048&r1=678047&r2=678048&view=diff ============================================================================== --- maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestJavadocReport.java (original) +++ maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestJavadocReport.java Fri Jul 18 14:38:01 2008 @@ -54,6 +54,7 @@ * Specifies the title to be placed near the top of the overview summary file. *
* See doctitle. + *
* * @parameter expression="${doctitle}" default-value="${project.name} ${project.version} Test API" */ @@ -64,6 +65,7 @@ * specified by path/filename and place it on the Overview page (overview-summary.html). *
* See overview. + *
* * @parameter expression="${overview}" default-value="${basedir}/src/test/javadoc/overview.html" */ @@ -73,6 +75,7 @@ * Specifies the title to be placed in the HTML title tag. *
* See windowtitle. + *
* * @parameter expression="${windowtitle}" default-value="${project.name} ${project.version} Test API" */ @@ -92,6 +95,7 @@ /** * The name of the destination directory. + *
* * @parameter expression="${destDir}" default-value="testapidocs" */