-
Sub-task
-
Resolution: Done
-
Major
-
None
-
None
Identify artifacts corresponding to "supported" API modules. Generate aggregated JavaDoc by fetching the source JAR for each API artifact.
Enable APIViz if possible; use JBoss.org theme if possible.
Javadoc'd packages should be grouped by API.
It is also important that JDK classes are properly linked. This might mean linking to oracle's doc site for JavaSE like many projects do, or perhaps using locally-generated javadoc from OpenJDK perhaps.
Just to keep info on how to:
<plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <version>2.8.1-SNAPSHOT</version> <executions> <execution> <id>javadocs-dist</id> <goals><goal>aggregate-jar</goal></goals> <phase>validate</phase> <configuration> <includeDependencySources>true</includeDependencySources> <dependencySourceIncludes> <include>org.jboss.spec.javax.servlet:*</include> <include>org.jboss.spec.javax.ejb:*</include> ... </dependencySourceIncludes> </configuration> </execution> </executions> </plugin>
- is blocked by
-
AS7-4719 Javadoc bug prevents defining groups - MissingResourceException, key doclet.Same_package_name_used
- Resolved
-
WFLY-810 Javadoc tool fails on certain AS dependencies' sources.
- Open
- is related to
-
AS7-3323 Apply properties to modules to distinguish public and non-public APIs
- Resolved
-
JBAS-7277 Create public API documentation for the application server
- Closed
-
WFLY-758 Identify modules with inadequate/missing JavaDoc
- Open
- relates to
-
WFLY-316 Javadoc - exclude _private.* packages
- Open