Return-Path: X-Original-To: apmail-maven-commits-archive@www.apache.org Delivered-To: apmail-maven-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 3E3EDE983 for ; Fri, 25 Jan 2013 22:00:24 +0000 (UTC) Received: (qmail 74964 invoked by uid 500); 25 Jan 2013 22:00:24 -0000 Delivered-To: apmail-maven-commits-archive@maven.apache.org Received: (qmail 74895 invoked by uid 500); 25 Jan 2013 22:00:24 -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 74888 invoked by uid 99); 25 Jan 2013 22:00:24 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 25 Jan 2013 22:00:24 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.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, 25 Jan 2013 21:59:34 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id 435AB2388C27 for ; Fri, 25 Jan 2013 21:58:41 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r847980 [10/23] - in /websites/production/maven/content/jxr: ./ apidocs/ apidocs/org/ apidocs/org/apache/ apidocs/org/apache/maven/ apidocs/org/apache/maven/jxr/ apidocs/org/apache/maven/jxr/ant/ apidocs/org/apache/maven/jxr/ant/class-use/ ... Date: Fri, 25 Jan 2013 21:58:32 -0000 To: commits@maven.apache.org From: olamy@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20130125215841.435AB2388C27@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Added: websites/production/maven/content/jxr/apidocs/org/apache/maven/plugin/jxr/AggregatorJxrReport.html ============================================================================== --- websites/production/maven/content/jxr/apidocs/org/apache/maven/plugin/jxr/AggregatorJxrReport.html (added) +++ websites/production/maven/content/jxr/apidocs/org/apache/maven/plugin/jxr/AggregatorJxrReport.html Fri Jan 25 21:58:29 2013 @@ -0,0 +1,349 @@ + + + + + +AggregatorJxrReport (Maven JXR Parent 2.4-SNAPSHOT API) + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
org.apache.maven.plugin.jxr
+

Class AggregatorJxrReport

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport
    +
    +
    +
    +
    public class AggregatorJxrReport
+extends JxrReport
    +
    Generates a combined JXR report in an aggregating project.
    +
    Since:
    +
    2.3
    +
    Is defined by the goal name:
    aggregate
    Aggregates the Maven project and its child modules.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AggregatorJxrReport

        +
        public AggregatorJxrReport()
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2002-2013 The Apache Software Foundation. All Rights Reserved.

+ + \ No newline at end of file Added: websites/production/maven/content/jxr/apidocs/org/apache/maven/plugin/jxr/AggregatorJxrTestReport.html ============================================================================== --- websites/production/maven/content/jxr/apidocs/org/apache/maven/plugin/jxr/AggregatorJxrTestReport.html (added) +++ websites/production/maven/content/jxr/apidocs/org/apache/maven/plugin/jxr/AggregatorJxrTestReport.html Fri Jan 25 21:58:29 2013 @@ -0,0 +1,349 @@ + + + + + +AggregatorJxrTestReport (Maven JXR Parent 2.4-SNAPSHOT API) + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
org.apache.maven.plugin.jxr
+

Class AggregatorJxrTestReport

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport
    +
    +
    +
    +
    public class AggregatorJxrTestReport
+extends JxrTestReport
    +
    Generates a combined JXR report for test code in an aggregating project.
    +
    Since:
    +
    2.3
    +
    Is defined by the goal name:
    test-aggregate
    Aggregates the Maven project and its child modules.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AggregatorJxrTestReport

        +
        public AggregatorJxrTestReport()
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2002-2013 The Apache Software Foundation. All Rights Reserved.

+ + \ No newline at end of file Added: websites/production/maven/content/jxr/apidocs/org/apache/maven/plugin/jxr/JxrReport.html ============================================================================== --- websites/production/maven/content/jxr/apidocs/org/apache/maven/plugin/jxr/JxrReport.html (added) +++ websites/production/maven/content/jxr/apidocs/org/apache/maven/plugin/jxr/JxrReport.html Fri Jan 25 21:58:29 2013 @@ -0,0 +1,471 @@ + + + + + +JxrReport (Maven JXR Parent 2.4-SNAPSHOT API) + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
org.apache.maven.plugin.jxr
+

Class JxrReport

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport
    +
    +
    +
    Direct Known Subclasses:
    +
    AggregatorJxrReport
    +
    +
    +
    +
    public class JxrReport
+extends AbstractJxrReport
    +
    Creates an html-based, cross referenced version of Java source code + for a project.
    +
    Version:
    +
    $Id: JxrReport.java 637378 2008-03-15 09:47:19Z bentmann $
    +
    Author:
    +
    Fabrice Bellingard
    +
    Is defined by the goal name:
    jxr
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        JxrReport

        +
        public JxrReport()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + + + + + +
        +
      • +

        getDescription

        +
        public String getDescription(Locale locale)
        +
        See Also:
        MavenReport.getDescription(java.util.Locale)
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public String getName(Locale locale)
        +
        See Also:
        MavenReport.getName(java.util.Locale)
        +
        • +
      + + + +
        +
      • +

        getOutputName

        +
        public String getOutputName()
        +
        See Also:
        MavenReport.getOutputName()
        +
        • +
      + + + + + + + +
        +
      • +

        setReportOutputDirectory

        +
        public void setReportOutputDirectory(File reportOutputDirectory)
        +
        +
        Specified by:
        +
        setReportOutputDirectory in interface org.apache.maven.reporting.MavenReport
        +
        Overrides:
        +
        setReportOutputDirectory in class org.apache.maven.reporting.AbstractMavenReport
        +
        See Also:
        AbstractMavenReport.setReportOutputDirectory(java.io.File)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2002-2013 The Apache Software Foundation. All Rights Reserved.

+ + \ No newline at end of file Added: websites/production/maven/content/jxr/apidocs/org/apache/maven/plugin/jxr/JxrReportUtil.html ============================================================================== --- websites/production/maven/content/jxr/apidocs/org/apache/maven/plugin/jxr/JxrReportUtil.html (added) +++ websites/production/maven/content/jxr/apidocs/org/apache/maven/plugin/jxr/JxrReportUtil.html Fri Jan 25 21:58:29 2013 @@ -0,0 +1,343 @@ + + + + + +JxrReportUtil (Maven JXR Parent 2.4-SNAPSHOT API) + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
org.apache.maven.plugin.jxr
+

Class JxrReportUtil

+
+
+ +
+
    +
  • +
    +
    +
    public class JxrReportUtil
+extends Object
    +
    Utility class for the jxr report.
    +
    Version:
    +
    $Id: JxrReportUtil.java 1145180 2011-07-11 14:02:55Z bimargulies $
    +
    Author:
    +
    Vincent Siveton
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      JxrReportUtil() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      protected static StringgetMavenJavadocPluginBasicOption(org.apache.maven.project.MavenProject project, + String optionName, + String defaultValue) +
      Return the optionName value defined in a project for the "maven-javadoc-plugin" plugin.
      +
      protected static ListgetMavenJavadocPlugins(org.apache.maven.project.MavenProject project) +
      Return the plugin references for the javadoc plugin in a project.
      +
      protected static StringgetStructure(org.apache.maven.project.MavenProject project, + boolean ignoreMissingSiteUrl) +
      Generates the site structure using the project hierarchy (project and its modules) or using the + distributionManagement elements from the pom.xml.
      +
      protected static booleanisJavadocAggregated(org.apache.maven.project.MavenProject project) +
      Determine if javadoc is aggregated in this project, paying attention to both + TODO: take cognizance of javadoc versus test-javadoc + the old parameter and the new mojo.
      +
      + +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        JxrReportUtil

        +
        public JxrReportUtil()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isJavadocAggregated

        +
        protected static boolean isJavadocAggregated(org.apache.maven.project.MavenProject project)
+                                      throws IOException
        +
        Determine if javadoc is aggregated in this project, paying attention to both + TODO: take cognizance of javadoc versus test-javadoc + the old parameter and the new mojo.
        +
        Parameters:
        project -
        +
        Returns:
        +
        Throws:
        +
        IOException
        +
        • +
      + + + +
        +
      • +

        getMavenJavadocPluginBasicOption

        +
        protected static String getMavenJavadocPluginBasicOption(org.apache.maven.project.MavenProject project,
+                                      String optionName,
+                                      String defaultValue)
+                                                  throws IOException
        +
        Return the optionName value defined in a project for the "maven-javadoc-plugin" plugin.
        +
        Parameters:
        project - not null
        optionName - the option name wanted
        defaultValue - a default value
        +
        Returns:
        the value for the option name or the default value. Could be null if not found.
        +
        Throws:
        +
        IOException - if any
        +
        • +
      + + + +
        +
      • +

        getMavenJavadocPlugins

        +
        protected static List getMavenJavadocPlugins(org.apache.maven.project.MavenProject project)
+                                      throws IOException
        +
        Return the plugin references for the javadoc plugin in a project.
        +
        Parameters:
        project - not null
        +
        Throws:
        +
        IOException - if any
        +
        • +
      + + + +
        +
      • +

        getStructure

        +
        protected static String getStructure(org.apache.maven.project.MavenProject project,
+                  boolean ignoreMissingSiteUrl)
+                              throws IOException
        +
        Generates the site structure using the project hierarchy (project and its modules) or using the + distributionManagement elements from the pom.xml.
        +
        Parameters:
        project -
        ignoreMissingSiteUrl -
        +
        Returns:
        the structure relative path
        +
        Throws:
        +
        IOException - if any
        See Also:
        org.apache.maven.plugins.site.SiteStageMojo#getStructure( MavenProject project, boolean ignoreMissingSiteUrl )
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2002-2013 The Apache Software Foundation. All Rights Reserved.

+ + \ No newline at end of file