sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject [sis] 01/04: Omit the navigation bar in javadoc.jar files deployed by Maven, because those javadoc are typically browsed from browser. This is a first attempt to avoid the inclusion of GPL code in javadoc (introduced by the search field in navigation bar). This change does not apply to aggregated javadoc, and is not yet sufficient for avoiding the GPL code anyway.
Date Wed, 12 Aug 2020 23:56:13 GMT
This is an automated email from the ASF dual-hosted git repository.

desruisseaux pushed a commit to branch geoapi-4.0
in repository https://gitbox.apache.org/repos/asf/sis.git

commit f3378db4efe7298c71798908aed7d14822362d96
Author: Martin Desruisseaux <martin.desruisseaux@geomatys.com>
AuthorDate: Wed Aug 12 18:58:45 2020 +0200

    Omit the navigation bar in javadoc.jar files deployed by Maven, because those javadoc
are typically browsed from browser.
    This is a first attempt to avoid the inclusion of GPL code in javadoc (introduced by the
search field in navigation bar).
    This change does not apply to aggregated javadoc, and is not yet sufficient for avoiding
the GPL code anyway.
---
 pom.xml | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/pom.xml b/pom.xml
index 8d49462..d869a00 100644
--- a/pom.xml
+++ b/pom.xml
@@ -592,6 +592,18 @@
         <maven.compiler.optimize>true</maven.compiler.optimize>
         <org.apache.sis.test.extensive>true</org.apache.sis.test.extensive>
       </properties>
+      <build>
+        <plugins>
+          <plugin>
+            <!-- Configuration of Javadoc attached to Maven artifacts (not aggregated
javadoc). -->
+            <artifactId>maven-javadoc-plugin</artifactId>
+            <configuration>
+              <nonavbar>true</nonavbar>         <!-- Navigation bar not used
when Javadoc is browsed from IDE. -->
+              <doclint>-reference</doclint>     <!-- Cross-modules references
are valid only in aggregated javadoc. -->
+            </configuration>
+          </plugin>
+        </plugins>
+      </build>
     </profile>
 
     <!-- ===================================================================


Mime
View raw message