Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8180336

Pass -group option to javadoc

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: P2
    • Resolution: Duplicate
    • Affects Version/s: 9
    • Fix Version/s: None
    • Component/s: infrastructure
    • Labels:

      Description

      JDK-8178043 extends javadoc to allow module grouping and the overview summary page can be generated to have one section/table per each group.

      The following patch is a prototype to separate the modules in Java SE, JDK, JavaFX groups. java.smartcardio and java.jnlp will fall into the "Other Modules" group since they are not Java SE.

      The -group option for JavaFX group may need to be conditional (not sure if javadoc will generate an empty table when javafx.* modules are not present in the build).

      diff --git a/make/Docs.gmk b/make/Docs.gmk
      --- a/make/Docs.gmk
      +++ b/make/Docs.gmk
      @@ -192,6 +192,10 @@
       endef
       
       ################################################################################
      +JAVA_SE_MODULES := $(strip $(subst ::,:,$(subst $(SPACE),:,$(strip java.se.ee \
      + $(call FindTransitiveDepsForModules, java.se.ee)))))
      +
      +################################################################################
       # Setup make rules for creating the API documentation, using javadoc and other
       # tools if needed.
       #
      @@ -232,6 +236,11 @@
         $1_OPTIONS += --module-source-path $$(MODULES_SOURCE_PATH)
         $1_OPTIONS += --module $$(call CommaList, $$($1_MODULES))
       
      + # module groups
      + $1_OPTIONS += -group "Java SE" "$(JAVA_SE_MODULES)"
      + $1_OPTIONS += -group "JDK" "jdk.*"
      + $1_OPTIONS += -group "JavaFX" "javafx.*"
      +
         # Create a string like "-Xdoclint:all,-syntax,-html,..."
         $1_OPTIONS += -Xdoclint:all,$$(call CommaList, $$(addprefix -, \
             $$(JAVADOC_DISABLED_DOCLINT)))

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              ihse Magnus Ihse Bursie
              Reporter:
              mchung Mandy Chung
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: