"Fossies" - the Fresh Open Source Software Archive

Member "wildfly-18.0.1.Final-src/feature-pack/javadoc/README.txt" (5 Nov 2019, 1982 Bytes) of package /linux/www/wildfly-18.0.1.Final-src.zip:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the last Fossies "Diffs" side-by-side code changes report for "README.txt": 14.0.1.Final-src_vs_15.0.0.Final-src.

    1 
    2 
    3 How to create Public JBoss AS API aggregated JavaDoc
    4 ====================================================
    5 
    6 1) Rebuild AS to get the modules into <AS>/build/target .
    7 
    8 2) run ./extractPublicApiArtifactsList.sh
    9 This will print out a list of artifacts in this format:
   10 
   11 <include>com.h2database:h2</include>
   12 <include>org.dom4j:dom4j</include>
   13 <include>javax.activation:activation</include>
   14 ...
   15 
   16 3) Put these includes into build/pom.xml to the "javadocDist" profile.
   17 
   18 4) Run extractPackageGroupsByModules.sh
   19 This will print out a list of javadoc groups in XML format:
   20     <group>
   21         <title>Module org.jboss.com.sun.httpserver</title>
   22         <packages>org.jboss.com.sun.net.httpserver:org.jboss.com.sun.net.httpserver.spi:org.jboss.sun.net.httpserver</packages>
   23     </group>
   24     <group>
   25         <title>Module org.jboss.common-beans</title>
   26         <packages>org.jboss.common.beans.property</packages>
   27     </group>
   28 
   29     Put these group definitions into build/pom.xml to the "javadocDist" profile.
   30 
   31 5) cd <AS>/build;
   32    mvn javadoc:aggregate -PjavadocDist -Djavadoc.branding='JBoss Enterprise Application Platform 6.0.0.GA';
   33    ("javadoc.branding" will be used for page titles, headers, footers etc. Default is "JBoss Application Server public API - ${version}".)
   34 
   35 This may fail because of AS7-4557 - Javadoc tool fails on certain AS dependencies' sources.
   36 Workaround: Find which artifacts cause this issue and remove them from the set of <include>'s.
   37 
   38 6) Another Javadoc bug is AS7-4719: MissingResourceException, key doclet.Same_package_name_used
   39 
   40 Workaround: Find which groups cause this issue and remove the affected packages from their <packages>.
   41 This is done by extractPackageGroupsByModules.sh but might happen when edited manually.
   42 TattleTale duplicated classes report may help with this.
   43 
   44 7) When done, aggregated JavaDoc will be created in:
   45   target/apidocs
   46   target/jboss-as-build-<version>-javadoc.jar
   47 
   48 8) Check that the final result contains all packages it should.
   49 
   50 
   51 
   52