JavaDoc building process

Couple of worlds about javadoc building process if you suddenly want to make plain javadoc from source. All javadoc stuff is concentrated in the ROOT/build/core/droiddoc.mk. Find javadoc call in it and change options set so that to exclude droiddoc custom doclet, i.e. from

javadoc \
    \@$(PRIVATE_SRC_LIST_FILE) \
    -J-Xmx768m \
    -J-Djava.library.path=$(HOST_OUT_SHARED_LIBRARIES) \
    $(PRIVATE_PROFILING_OPTIONS) \
    -quiet \
    -doclet DroidDoc \
    -docletpath $(PRIVATE_DOCLETPATH) \
    -templatedir $(PRIVATE_CUSTOM_TEMPLATE_DIR) \
    -templatedir $(PRIVATE_TEMPLATE_DIR) \
    $(PRIVATE_DROIDDOC_HTML_DIR) \
    $(addprefix -classpath ,$(PRIVATE_CLASSPATH)) \
    -sourcepath $(PRIVATE_SOURCE_PATH)$(addprefix :,$(PRIVATE_CLASSPATH)) \
    -d $(PRIVATE_OUT_DIR) \
    $(PRIVATE_CURRENT_BUILD) $(PRIVATE_CURRENT_TIME) \
    $(PRIVATE_DROIDDOC_OPTIONS) \

to something like this

javadoc \
    \@$(PRIVATE_SRC_LIST_FILE) \
    -J-Xmx768m \
    -J-Djava.library.path=$(HOST_OUT_SHARED_LIBRARIES) \
    $(PRIVATE_PROFILING_OPTIONS) \
    -overview ~/mydroid/frameworks/base/core/java/overview.html \
    -splitindex \
    -use \
    -package \
    $(addprefix -classpath ,$(PRIVATE_CLASSPATH)) \
    -sourcepath $(PRIVATE_SOURCE_PATH)$(addprefix :,$(PRIVATE_CLASSPATH)) \
    -d $(PRIVATE_OUT_DIR) \

and run Android building. The such javadoc execution ends with 6938 warnings. They include unknown tags, errors and mistakes in source comments and droiddoc doclet orientation issues. The especial attention is need to turn to the @hide tag which standard doclet can’t interpret and which hides non-SDK source and thus this code shouldn’t be used in applications. My conclusion is the standard doclet must be extended to support all Android source features and to get valuable documentation.


Posted under How-to, Issues by Sergei Goorov on November 5, 2008

2 Comments so far

  1. mypapit December 10, 2008 4:28 pm

    thanks for starting this site! its been helpful for me when programming android

  2. Matt J. September 25, 2010 3:30 am

    It seems you are implying we cannot use the Sun javadoc tool, we must build a Android version instead. Then it would be a good idea to state this explicitly somewhere.

Leave a Comment

Name (required)

Email (required)

Website

Comments

Security Code (required)


More Blog Post