Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

use mvn site to generate javadoc jar #460

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

use mvn site to generate javadoc jar #460

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
68a70cb
use mvn site to generate javadoc jar
jodygarnett Aug 15, 2019
14e8baa
Use a profile to build javadocs
jodygarnett Aug 15, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 64 additions & 45 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,15 @@
Build JTS Topology Suite and install in local repository:
mvn install

Build everything and skip tests:
Build and skip tests:
mvn clean install -DskipTests

Build and generate javadocs jars:
mvn clean install -Pjavadoc

Build only javadoc jars:
mvn javadoc:javadoc -Pjavadoc

Setup for eclipse development:
mvn eclipse:eclipse

Expand Down Expand Up @@ -179,6 +185,63 @@
</plugins>
</build>
</profile>
<profile>
<id>javadoc</id>
<activation>
<property>
<name>release</name> <!-- include javadocs in release -->
</property>
</activation>
<build>
<plugins>
<plugin>
<!-- javadoc build configuration generates "attached" javadoc bundles for mvn deploy -->
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.0.0-M1</version>
<configuration>
<show>public</show>
<header>${project.name} ${project.version}</header>
<footer>${project.name} ${project.version}</footer>
<overview>${basedir}/modules/core/src/main/javadoc/overview.html</overview>

<excludePackageNames>org.locationtech.jtsexample.*,org.locationtech.jtstest,org.locationtech.jtstest.*</excludePackageNames>
<!--failOnError>false</failOnError--> <!-- javadocs do not build right now -->
<groups>
<group>
<title>Core - Geometry</title>
<packages>org.locationtech.jts.geom:org.locationtech.jts.geom.*</packages>
</group>
<group>
<title>Core - I/O</title>
<packages>org.locationtech.jts.io</packages>
</group>
<group>
<title>Core - Algorithms</title>
<packages>org.locationtech.jts.algorithm:org.locationtech.jts.algorithm.*:org.locationtech.jts.densify:org.locationtech.jts.dissolve:org.locationtech.jts.linearref:org.locationtech.jts.operation.*:org.locationtech.jts.simplify:org.locationtech.jts.triangulate</packages>
</group>
<group>
<title>Core - Other</title>
<packages>org.locationtech.jts:org.locationtech.jts.*</packages>
</group>
<group>
<title>I/O - Common</title>
<packages>org.locationtech.jts.io.*</packages>
</group>
</groups>
</configuration>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
</profiles>

<!-- =========================================================== -->
Expand All @@ -202,50 +265,6 @@
</excludes>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.0.0-M1</version>
<configuration>
<show>public</show>
<header>${project.name} ${project.version}</header>
<footer>${project.name} ${project.version}</footer>
<overview>${basedir}/modules/core/src/main/javadoc/overview.html</overview>

<excludePackageNames>org.locationtech.jtsexample.*,org.locationtech.jtstest,org.locationtech.jtstest.*</excludePackageNames>
<failOnError>false</failOnError>
<groups>
<group>
<title>Core - Geometry</title>
<packages>org.locationtech.jts.geom:org.locationtech.jts.geom.*</packages>
</group>
<group>
<title>Core - I/O</title>
<packages>org.locationtech.jts.io</packages>
</group>
<group>
<title>Core - Algorithms</title>
<packages>org.locationtech.jts.algorithm:org.locationtech.jts.algorithm.*:org.locationtech.jts.densify:org.locationtech.jts.dissolve:org.locationtech.jts.linearref:org.locationtech.jts.operation.*:org.locationtech.jts.simplify:org.locationtech.jts.triangulate</packages>
</group>
<group>
<title>Core - Other</title>
<packages>org.locationtech.jts:org.locationtech.jts.*</packages>
</group>
<group>
<title>I/O - Common</title>
<packages>org.locationtech.jts.io.*</packages>
</group>
</groups>
</configuration>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
Expand Down