< prev index next >

make/Docs.gmk

Print this page




  44 #
  45 # We will generate API documentation for two different selections of the source
  46 # code: "Java SE", which contains just the modules covered by the top-level
  47 # module java.se.ee, and "JDK", which covers all of Java SE and also all
  48 # other available modules that should be documented, including imported modules,
  49 # if any.
  50 #
  51 # We will also generate separate, free-standing specifications from either
  52 # markdown or existing html files.
  53 #
  54 
  55 ################################################################################
  56 # Javadoc settings
  57 
  58 # On top of the sources that was used to compile the JDK, we need some
  59 # extra java.rmi sources that are used just for javadoc.
  60 MODULES_SOURCE_PATH := $(call PathList, $(call GetModuleSrcPath) \
  61     $(SUPPORT_OUTPUTDIR)/rmic/* $(TOPDIR)/src/*/share/doc/stub)
  62 
  63 # URLs
  64 JAVADOC_BASE_URL := http://www.oracle.com/pls/topic/lookup?ctx=javase9&amp;id=homepage
  65 BUG_SUBMIT_URL := http://bugreport.java.com/bugreport/
  66 COPYRIGHT_URL := {@docroot}/../legal/copyright.html
  67 LICENSE_URL := http://www.oracle.com/technetwork/java/javase/terms/license/java10speclicense.html
  68 REDISTRIBUTION_URL := http://www.oracle.com/technetwork/java/redist-137594.html
  69 
  70 # In order to get a specific ordering it's necessary to specify the total
  71 # ordering of tags as the tags are otherwise ordered in order of definition.
  72 JAVADOC_TAGS := \
  73     -tag beaninfo:X \
  74     -tag revised:X \
  75     -tag since.unbundled:X \
  76     -tag spec:X \
  77     -tag specdefault:X \
  78     -tag Note:X \
  79     -tag ToDo:X \
  80     -tag 'apiNote:a:API Note:' \
  81     -tag 'implSpec:a:Implementation Requirements:' \
  82     -tag 'implNote:a:Implementation Note:' \
  83     -tag param \
  84     -tag return \




  44 #
  45 # We will generate API documentation for two different selections of the source
  46 # code: "Java SE", which contains just the modules covered by the top-level
  47 # module java.se.ee, and "JDK", which covers all of Java SE and also all
  48 # other available modules that should be documented, including imported modules,
  49 # if any.
  50 #
  51 # We will also generate separate, free-standing specifications from either
  52 # markdown or existing html files.
  53 #
  54 
  55 ################################################################################
  56 # Javadoc settings
  57 
  58 # On top of the sources that was used to compile the JDK, we need some
  59 # extra java.rmi sources that are used just for javadoc.
  60 MODULES_SOURCE_PATH := $(call PathList, $(call GetModuleSrcPath) \
  61     $(SUPPORT_OUTPUTDIR)/rmic/* $(TOPDIR)/src/*/share/doc/stub)
  62 
  63 # URLs
  64 JAVADOC_BASE_URL := http://www.oracle.com/pls/topic/lookup?ctx=javase10&amp;id=homepage
  65 BUG_SUBMIT_URL := http://bugreport.java.com/bugreport/
  66 COPYRIGHT_URL := {@docroot}/../legal/copyright.html
  67 LICENSE_URL := http://www.oracle.com/technetwork/java/javase/terms/license/java10speclicense.html
  68 REDISTRIBUTION_URL := http://www.oracle.com/technetwork/java/redist-137594.html
  69 
  70 # In order to get a specific ordering it's necessary to specify the total
  71 # ordering of tags as the tags are otherwise ordered in order of definition.
  72 JAVADOC_TAGS := \
  73     -tag beaninfo:X \
  74     -tag revised:X \
  75     -tag since.unbundled:X \
  76     -tag spec:X \
  77     -tag specdefault:X \
  78     -tag Note:X \
  79     -tag ToDo:X \
  80     -tag 'apiNote:a:API Note:' \
  81     -tag 'implSpec:a:Implementation Requirements:' \
  82     -tag 'implNote:a:Implementation Note:' \
  83     -tag param \
  84     -tag return \


< prev index next >