common/makefiles/javadoc/Javadoc.gmk

Print this page
rev 684 : 8008632: Additional JavaDoc tags @apiNote, @implSpec and @implNote
Reviewed-by: briangoetz


 373 # Run javadoc if the index file is out of date or missing
 374 $(COREAPI_INDEX_FILE): $(COREAPI_OPTIONS_FILE) $(COREAPI_PACKAGES_FILE)
 375         $(prep-javadoc)
 376         $(call JavadocSummary,$(COREAPI_OPTIONS_FILE),$(COREAPI_PACKAGES_FILE))
 377         $(JAVADOC_CMD) -d $(@D) \
 378           @$(COREAPI_OPTIONS_FILE) @$(COREAPI_PACKAGES_FILE)
 379 
 380 # Create file with javadoc options in it
 381 $(COREAPI_OPTIONS_FILE): $(COREAPI_OVERVIEW)
 382         $(prep-target)
 383         @($(call OptionOnly,$(COMMON_JAVADOCFLAGS))                     ; \
 384           $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH))      ; \
 385           $(call OptionPair,-encoding,ISO-8859-1)                       ; \
 386           $(call OptionPair,-tag,beaninfo:X)                            ; \
 387           $(call OptionPair,-tag,revised:X)                             ; \
 388           $(call OptionPair,-tag,since.unbundled:X)                     ; \
 389           $(call OptionPair,-tag,spec:X)                                ; \
 390           $(call OptionPair,-tag,specdefault:X)                         ; \
 391           $(call OptionPair,-tag,Note:X)                                ; \
 392           $(call OptionPair,-tag,ToDo:X)                                ; \











 393           $(call OptionPair,-tag,$(TAG_JLS))                            ; \
 394           $(call OptionOnly,-splitIndex)                                ; \
 395           $(call OptionPair,-overview,$(COREAPI_OVERVIEW))              ; \
 396           $(call OptionPair,-doctitle,$(COREAPI_DOCTITLE))              ; \
 397           $(call OptionPair,-windowtitle,$(COREAPI_WINDOWTITLE) $(DRAFT_WINTITLE)) ;\
 398           $(call OptionPair,-header,$(COREAPI_HEADER)$(DRAFT_HEADER))   ; \
 399           $(call OptionPair,-bottom,$(COREAPI_BOTTOM)$(DRAFT_BOTTOM))   ; \
 400         ) >> $@
 401 ifdef COREAPI_TOP_EARLYACCESS
 402         @$(call OptionPair,-top,$(COREAPI_TOP_EARLYACCESS)) >> $@
 403 endif
 404 
 405 # Create a file with the package names in it
 406 $(COREAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(CORE_PKGS))
 407         $(prep-target)
 408         $(call PackageFilter,$(CORE_PKGS))
 409 
 410 #############################################################
 411 #
 412 # docletapidocs




 373 # Run javadoc if the index file is out of date or missing
 374 $(COREAPI_INDEX_FILE): $(COREAPI_OPTIONS_FILE) $(COREAPI_PACKAGES_FILE)
 375         $(prep-javadoc)
 376         $(call JavadocSummary,$(COREAPI_OPTIONS_FILE),$(COREAPI_PACKAGES_FILE))
 377         $(JAVADOC_CMD) -d $(@D) \
 378           @$(COREAPI_OPTIONS_FILE) @$(COREAPI_PACKAGES_FILE)
 379 
 380 # Create file with javadoc options in it
 381 $(COREAPI_OPTIONS_FILE): $(COREAPI_OVERVIEW)
 382         $(prep-target)
 383         @($(call OptionOnly,$(COMMON_JAVADOCFLAGS))                     ; \
 384           $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH))      ; \
 385           $(call OptionPair,-encoding,ISO-8859-1)                       ; \
 386           $(call OptionPair,-tag,beaninfo:X)                            ; \
 387           $(call OptionPair,-tag,revised:X)                             ; \
 388           $(call OptionPair,-tag,since.unbundled:X)                     ; \
 389           $(call OptionPair,-tag,spec:X)                                ; \
 390           $(call OptionPair,-tag,specdefault:X)                         ; \
 391           $(call OptionPair,-tag,Note:X)                                ; \
 392           $(call OptionPair,-tag,ToDo:X)                                ; \
 393           $(call OptionPair,-tag,apiNote:a:<em>API Note:</em>)      ; \
 394           $(call OptionPair,-tag,implSpec:a:<em>Implementation Requirements:</em>); \
 395           $(call OptionPair,-tag,implNote:a:<em>Implementation Note:</em>); \
 396           $(call OptionPair,-tag,param)                                 ; \
 397           $(call OptionPair,-tag,return)                                ; \
 398           $(call OptionPair,-tag,throws)                                ; \
 399           $(call OptionPair,-tag,since)                                 ; \
 400           $(call OptionPair,-tag,version)                               ; \
 401           $(call OptionPair,-tag,serialData)                            ; \
 402           $(call OptionPair,-tag,factory)                               ; \
 403           $(call OptionPair,-tag,see)                                   ; \
 404           $(call OptionPair,-tag,$(TAG_JLS))                            ; \
 405           $(call OptionOnly,-splitIndex)                                ; \
 406           $(call OptionPair,-overview,$(COREAPI_OVERVIEW))              ; \
 407           $(call OptionPair,-doctitle,$(COREAPI_DOCTITLE))              ; \
 408           $(call OptionPair,-windowtitle,$(COREAPI_WINDOWTITLE) $(DRAFT_WINTITLE)) ;\
 409           $(call OptionPair,-header,$(COREAPI_HEADER)$(DRAFT_HEADER))   ; \
 410           $(call OptionPair,-bottom,$(COREAPI_BOTTOM)$(DRAFT_BOTTOM))   ; \
 411         ) >> $@
 412 ifdef COREAPI_TOP_EARLYACCESS
 413         @$(call OptionPair,-top,$(COREAPI_TOP_EARLYACCESS)) >> $@
 414 endif
 415 
 416 # Create a file with the package names in it
 417 $(COREAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(CORE_PKGS))
 418         $(prep-target)
 419         $(call PackageFilter,$(CORE_PKGS))
 420 
 421 #############################################################
 422 #
 423 # docletapidocs