Uploaded image for project: 'Application Server 7'
  1. Application Server 7
  2. AS7-458 Consolidated AS 7 Javadocs
  3. AS7-582

Create aggregated JBoss AS Javadoc.

    XMLWordPrintable

Details

    • Sub-task
    • Resolution: Done
    • Major
    • 7.1.2.Final (EAP)
    • None
    • Build System
    • None

    Description

      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>

      Attachments

        Issue Links

          is blocked by

          Bug - A problem that impairs or prevents the functions of the product. AS7-4719 Javadoc bug prevents defining groups - MissingResourceException, key doclet.Same_package_name_used

          • Minor - To be worked after urgent, high, and medium priorities are resolved. This term is chosen when the severity of the issue is low, or the complexity or effort to correct it may be higher, relatively speaking. For low priority issues, known workarounds exist or are not needed due to the trivial effort needed to address the issue.
          • Resolved

          Bug - A problem that impairs or prevents the functions of the product. WFLY-810 Javadoc tool fails on certain AS dependencies' sources.

          • Minor - To be worked after urgent, high, and medium priorities are resolved. This term is chosen when the severity of the issue is low, or the complexity or effort to correct it may be higher, relatively speaking. For low priority issues, known workarounds exist or are not needed due to the trivial effort needed to address the issue.
          • Open
          is related to

          Task - Represents a small unit of work that is not end-user facing. AS7-3323 Apply properties to modules to distinguish public and non-public APIs

          • Blocker - To be worked above all other priorities. This term is chosen when the severity of the issue is very high, has no workaround, or the effort for the change is comparatively low. Issues that may be very publicly visible and could generate significant media attention may also drive a higher priority.
          • Resolved

          Task - Represents a small unit of work that is not end-user facing. JBAS-7277 Create public API documentation for the application server

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Closed

          Task - Represents a small unit of work that is not end-user facing. WFLY-758 Identify modules with inadequate/missing JavaDoc

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Open
          relates to

          Feature Request - Feature requests from customers and/or users WFLY-316 Javadoc - exclude _private.* packages

          • Minor - To be worked after urgent, high, and medium priorities are resolved. This term is chosen when the severity of the issue is low, or the complexity or effort to correct it may be higher, relatively speaking. For low priority issues, known workarounds exist or are not needed due to the trivial effort needed to address the issue.
          • Open

          Activity

            People

              ozizka_jira Ondrej Zizka (Inactive)
              dlloyd@redhat.com David Lloyd
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: