Skip to content

Commit 7f452fb

Browse files
authored
feat: add devsite javadoc profile (#121)
* feat: add Devsite Javadoc profile * fix: output dir, google/io, comments, remove memory flag * Don't delete package-list * Fix _project.yaml path * Remove docs from path
1 parent cfa0342 commit 7f452fb

File tree

1 file changed

+95
-0
lines changed

1 file changed

+95
-0
lines changed

pom.xml

+95
Original file line numberDiff line numberDiff line change
@@ -572,5 +572,100 @@
572572
<skipITs>false</skipITs>
573573
</properties>
574574
</profile>
575+
<profile>
576+
<id>devsite-apidocs</id>
577+
<activation>
578+
<property>
579+
<!-- Activate with the -Ddevsite.template=/path/to/templates flag. -->
580+
<name>devsite.template</name>
581+
</property>
582+
</activation>
583+
<build>
584+
<plugins>
585+
<plugin>
586+
<!-- Generate API docs using Doclava for the developer site. -->
587+
<artifactId>maven-javadoc-plugin</artifactId>
588+
<!-- Note: version 3.x.x uses additionalOption instead of additionalparam. -->
589+
<version>3.1.1</version>
590+
<executions>
591+
<execution>
592+
<phase>site</phase>
593+
<goals>
594+
<goal>aggregate</goal>
595+
</goals>
596+
</execution>
597+
</executions>
598+
<configuration>
599+
<docletArtifact>
600+
<groupId>com.google.doclava</groupId>
601+
<artifactId>doclava</artifactId>
602+
<version>1.0.6</version>
603+
</docletArtifact>
604+
<doclet>com.google.doclava.Doclava</doclet>
605+
<bootclasspath>${sun.boot.class.path}</bootclasspath>
606+
<additionalDependencies>
607+
<additionalDependency>
608+
<groupId>com.google.j2objc</groupId>
609+
<artifactId>j2objc-annotations</artifactId>
610+
<version>1.3</version>
611+
</additionalDependency>
612+
</additionalDependencies>
613+
<additionalOptions>
614+
<additionalOption>-hdf</additionalOption>
615+
<additionalOption>book.path</additionalOption>
616+
<additionalOption>/java/_book.yaml</additionalOption>
617+
<additionalOption>-hdf</additionalOption>
618+
<additionalOption>project.path</additionalOption>
619+
<additionalOption>/java/_project.yaml</additionalOption>
620+
<additionalOption>-hdf</additionalOption>
621+
<additionalOption>devsite.path</additionalOption>
622+
<additionalOption>/java/reference/</additionalOption>
623+
<additionalOption>-d</additionalOption>
624+
<additionalOption>${project.build.directory}/devsite</additionalOption>
625+
<additionalOption>-templatedir</additionalOption>
626+
<additionalOption>${devsite.template}</additionalOption>
627+
<additionalOption>-toroot</additionalOption>
628+
<additionalOption>/java/reference/</additionalOption>
629+
<additionalOption>-yaml</additionalOption>
630+
<additionalOption>_toc.yaml</additionalOption>
631+
<additionalOption>-warning</additionalOption>
632+
<additionalOption>101</additionalOption>
633+
</additionalOptions>
634+
<useStandardDocletOptions>false</useStandardDocletOptions>
635+
</configuration>
636+
</plugin>
637+
<plugin>
638+
<!-- Clean up some references and files. -->
639+
<artifactId>maven-antrun-plugin</artifactId>
640+
<version>1.7</version>
641+
<executions>
642+
<execution>
643+
<phase>site</phase>
644+
<goals>
645+
<goal>run</goal>
646+
</goals>
647+
<configuration>
648+
<target>
649+
<echo message="Updating relative links in API docs" />
650+
<!-- TODO: What is the right behavior for io* and google*? -->
651+
<replace dir="${project.build.directory}/devsite" token="href=&quot;com" value="href=&quot;/java/reference/com" />
652+
<replace dir="${project.build.directory}/devsite" token="href=&quot;io" value="href=&quot;/java/reference/io" />
653+
<replace dir="${project.build.directory}/devsite" token="href=&quot;google" value="href=&quot;/java/reference/google" />
654+
<copy file="${project.build.directory}/devsite/assets/_toc.yaml" todir="${project.build.directory}/devsite/reference" />
655+
<echo message="Removing files not needed by Devsite" />
656+
<delete file="${project.build.directory}/devsite/reference/classes.html" />
657+
<delete file="${project.build.directory}/devsite/reference/hierarchy.html" />
658+
<delete file="${project.build.directory}/devsite/reference/index.html" />
659+
<delete file="${project.build.directory}/devsite/reference/lists.js" />
660+
<delete file="${project.build.directory}/devsite/reference/packages.html" />
661+
<delete file="${project.build.directory}/devsite/reference/current.xml" />
662+
</target>
663+
</configuration>
664+
</execution>
665+
</executions>
666+
</plugin>
667+
</plugins>
668+
</build>
669+
</profile>
575670
</profiles>
576671
</project>

0 commit comments

Comments
 (0)