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

feat: add Devsite Javadoc profile #121

Merged
merged 5 commits into from Apr 2, 2020
Merged

feat: add Devsite Javadoc profile #121

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
364e473
feat: add Devsite Javadoc profile
tbpg Mar 30, 2020
73bf509
fix: output dir, google/io, comments, remove memory flag
tbpg Mar 31, 2020
f7ae81f
Don't delete package-list
tbpg Apr 1, 2020
3878570
Fix _project.yaml path
tbpg Apr 1, 2020
8c5b42e
Remove docs from path
tbpg Apr 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
96 changes: 96 additions & 0 deletions pom.xml
View file
Open in desktop
Expand Up @@ -572,5 +572,101 @@
<skipITs>false</skipITs>
</properties>
</profile>
<profile>
<id>devsite-apidocs</id>
<activation>
<property>
<!-- Activate with the -Ddevsite.template=/path/to/templates flag. -->
<name>devsite.template</name>
BenWhitehead marked this conversation as resolved.
Show resolved Hide resolved
</property>
</activation>
<build>
<plugins>
<plugin>
<!-- Generate API docs using Doclava for the developer site. -->
<artifactId>maven-javadoc-plugin</artifactId>
<!-- Note: version 3.x.x uses additionalOption instead of additionalparam. -->
<version>3.1.1</version>
<executions>
<execution>
<phase>site</phase>
<goals>
<goal>aggregate</goal>
</goals>
</execution>
</executions>
<configuration>
<docletArtifact>
<groupId>com.google.doclava</groupId>
<artifactId>doclava</artifactId>
<version>1.0.6</version>
</docletArtifact>
<doclet>com.google.doclava.Doclava</doclet>
<bootclasspath>${sun.boot.class.path}</bootclasspath>
<additionalDependencies>
<additionalDependency>
<groupId>com.google.j2objc</groupId>
<artifactId>j2objc-annotations</artifactId>
<version>1.3</version>
</additionalDependency>
</additionalDependencies>
<additionalOptions>
<additionalOption>-hdf</additionalOption>
<additionalOption>book.path</additionalOption>
<additionalOption>/java/_book.yaml</additionalOption>
<additionalOption>-hdf</additionalOption>
<additionalOption>project.path</additionalOption>
<additionalOption>/_project.yaml</additionalOption>
<additionalOption>-hdf</additionalOption>
<additionalOption>devsite.path</additionalOption>
<additionalOption>/java/docs/reference/</additionalOption>
<additionalOption>-d</additionalOption>
<additionalOption>${project.build.directory}/devsite</additionalOption>
<additionalOption>-templatedir</additionalOption>
<additionalOption>${devsite.template}</additionalOption>
<additionalOption>-toroot</additionalOption>
<additionalOption>/java/docs/reference/</additionalOption>
<additionalOption>-yaml</additionalOption>
<additionalOption>_toc.yaml</additionalOption>
<additionalOption>-warning</additionalOption>
<additionalOption>101</additionalOption>
</additionalOptions>
<useStandardDocletOptions>false</useStandardDocletOptions>
</configuration>
</plugin>
<plugin>
<!-- Clean up some references and files. -->
<artifactId>maven-antrun-plugin</artifactId>
<version>1.7</version>
<executions>
<execution>
<phase>site</phase>
<goals>
<goal>run</goal>
</goals>
<configuration>
<target>
<echo message="Updating relative links in API docs" />
<!-- TODO: What is the right behavior for io* and google*? -->
<replace dir="${project.build.directory}/devsite" token="href=&quot;com" value="href=&quot;/java/docs/reference/com" />
<replace dir="${project.build.directory}/devsite" token="href=&quot;io" value="href=&quot;/java/docs/reference/io" />
<replace dir="${project.build.directory}/devsite" token="href=&quot;google" value="href=&quot;/java/docs/reference/google" />
<copy file="${project.build.directory}/devsite/assets/_toc.yaml" todir="${project.build.directory}/devsite/reference" />
<echo message="Removing files not needed by Devsite" />
<delete file="${project.build.directory}/devsite/reference/classes.html" />
<delete file="${project.build.directory}/devsite/reference/hierarchy.html" />
<delete file="${project.build.directory}/devsite/reference/index.html" />
<delete file="${project.build.directory}/devsite/reference/lists.js" />
<delete file="${project.build.directory}/devsite/reference/package-list" />
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We will want to keep package-list available for cross-linking between javadocs. This is the file that is referenced when the javadoc command is provided -link option [1].

[1] https://docs.oracle.com/javase/9/javadoc/javadoc-command.htm#JSJAV-GUID-3894CFD5-88D5-407F-B603-3DCC826AE6EA

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, and good to know! I removed this line.

<delete file="${project.build.directory}/devsite/reference/packages.html" />
<delete file="${project.build.directory}/devsite/reference/current.xml" />
</target>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
</profiles>
</project>