You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sis.apache.org by de...@apache.org on 2013/08/08 16:31:44 UTC

svn commit: r1511805 - in /sis/branches/0.3: ./ pom.xml

Author: desruisseaux
Date: Thu Aug  8 14:31:44 2013
New Revision: 1511805

URL: http://svn.apache.org/r1511805
Log:
Experience show that the Javadoc configuration needs to be copied in the <build> section for proper execution of our taglets.

Modified:
    sis/branches/0.3/   (props changed)
    sis/branches/0.3/pom.xml

Propchange: sis/branches/0.3/
------------------------------------------------------------------------------
  Merged /sis/tags/0.3:r1511804

Modified: sis/branches/0.3/pom.xml
URL: http://svn.apache.org/viewvc/sis/branches/0.3/pom.xml?rev=1511805&r1=1511804&r2=1511805&view=diff
==============================================================================
--- sis/branches/0.3/pom.xml (original)
+++ sis/branches/0.3/pom.xml Thu Aug  8 14:31:44 2013
@@ -486,6 +486,93 @@ Apache SIS is a free software, Java lang
           </dependency>
         </dependencies>
       </plugin>
+      <plugin>
+        <artifactId>maven-project-info-reports-plugin</artifactId>
+        <version>2.7</version>
+      </plugin>
+
+      <!-- Following is a copy-and-paste of maven-javadoc-plugin configuration in the <reporting> section.
+           Seems to be required for javadoc packaged as JAR files. -->
+      <plugin>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <version>2.9.1</version>
+        <configuration>
+          <source>${maven.compile.source}</source>              <!-- Enables javadoc to handle language constructs present in target JDK. -->
+          <encoding>${project.build.sourceEncoding}</encoding>  <!-- Encoding of Java source file. -->
+          <docencoding>${website.encoding}</docencoding>        <!-- Encoding of the generated HTML files. -->
+          <charset>${website.encoding}</charset>                <!-- Encoding to declare in the HTML META tag. -->
+          <locale>${website.locale}</locale>                    <!-- Locale for navigation bar, help file contents, etc. -->
+          <author>false</author>                                <!-- Excludes the authors text in the generated docs. -->
+          <version>false</version>                              <!-- Excludes the version text in the generated docs. -->
+          <nosince>true</nosince>                               <!-- Omits the "Since" sections associated with the since tags. -->
+          <noqualifier>all</noqualifier>                        <!-- Omit qualifying package name before class names in output. -->
+          <quiet>true</quiet>                                   <!-- Shuts off non-error and non-warning messages. -->
+          <keywords>true</keywords>                             <!-- Adds HTML meta keyword tags to the generated files. -->
+          <breakiterator>true</breakiterator>                   <!-- Better boundary detection when determining the end of the first sentence. -->
+          <stylesheetfile>src/main/javadoc/stylesheet.css</stylesheetfile>
+          <validateLinks>true</validateLinks>
+          <links>
+            <link>http://www.geoapi.org/3.0/javadoc</link>
+          </links>
+
+          <!-- Separates packages on the overview page into the groups specified. -->
+          <groups>
+            <group>
+              <title>Testing tools</title> <!-- Exists in test javadoc only. -->
+              <packages>org.apache.sis.test*</packages>
+            </group>
+            <group>
+              <title>Applications</title>
+              <packages>org.apache.sis.console*:org.apache.sis.services*</packages>
+            </group>
+            <group>
+              <title>Data storage</title>
+              <packages>org.apache.sis.storage*:org.apache.sis.index*</packages>
+            </group>
+            <group>
+              <title>Geometry</title>
+              <packages>org.apache.sis.geometry*</packages>
+            </group>
+            <group>
+              <title>Referencing</title>
+              <packages>org.apache.sis.referencing*:org.apache.sis.parameter*</packages>
+            </group>
+            <group>
+              <title>Metadata</title>
+              <packages>org.apache.sis.metadata*</packages>
+            </group>
+            <group>
+              <title>Utilities</title>
+              <packages>org.apache.sis.math*:org.apache.sis.measure*:org.apache.sis.util*:org.apache.sis.io*:org.apache.sis.xml*:org.apache.sis.setup*</packages>
+            </group>
+          </groups>
+
+          <!-- Internal packages to hide from javadoc. -->
+          <excludePackageNames>org.apache.sis.internal:com</excludePackageNames>
+
+          <!-- Custom taglets, some of them implemented in Java. -->
+          <tags>
+            <tag><placement>t</placement> <name>goal</name>     <head>Maven goal:</head></tag>
+            <tag><placement>t</placement> <name>phase</name>    <head>Maven phase:</head></tag>
+            <tag><placement>X</placement> <name>category</name> <head>Category:</head></tag>
+            <tag><placement>a</placement> <name>todo</name>     <head>TODO:</head></tag>
+          </tags>
+          <taglets>
+            <taglet><tagletClass>org.apache.sis.internal.taglet.Module</tagletClass></taglet>
+            <taglet><tagletClass>org.apache.sis.internal.taglet.WebSite</tagletClass></taglet>
+            <taglet><tagletClass>org.apache.sis.internal.taglet.Section</tagletClass></taglet>
+            <taglet><tagletClass>org.apache.sis.internal.taglet.Note</tagletClass></taglet>
+            <taglet><tagletClass>org.apache.sis.internal.taglet.Example</tagletClass></taglet>
+            <taglet><tagletClass>org.apache.sis.internal.taglet.Preformat</tagletClass></taglet>
+            <taglet><tagletClass>org.apache.sis.internal.taglet.SourceRepositoryURL</tagletClass></taglet>
+          </taglets>
+          <tagletArtifact>
+            <groupId>org.apache.sis.core</groupId>
+            <artifactId>sis-build-helper</artifactId>
+            <version>${sis.plugin.version}</version>
+          </tagletArtifact>
+        </configuration>
+      </plugin>
     </plugins>
 
     <!-- Following plugins are used only by some specific modules. -->