Android JavaDoc Just customary notion of Google Android documentaion

There are three oldest javadoc builds in the site, m3-rc37a, m5-rc15 and 0.9_beta. How much are they demanded now? Can they be painless removed or to the contrary should to add relevant info to them? Or something else? Put your opinions here in comments.

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.

As everybody knows Google has open sourced Android. And here is a result of building javadoc from source. The -package and -use options were used. My comments about specific features will be later.

There are some issues in the exposed here javadoc. The one is in the builds m3-rc37a, m5-rc15 and 0.9_beta non public constructors of some classes are public. This is my neglect. The next issues relate to impossibility to easy resolve @link and @see tags which refer to generic methods and xml-attributes. And biggest issue is that some methods’ parameters in real code and in the Google docs have different names. Thus, sources which have been used for creating docs and for building android.jar are different! That’s not good. And true way for me to resolve all these issues is building javadoc from source. Wait when Android will be open sourced.

This site with Android javadoc is exists about nine months, but only now it takes a distinct form. Couple words about how I make the javadoc - it’s result of matching Google Android documentation and generated code which is an Android API definition. Moreover, I include into documentation only real classes, fields and methods from “android.jar”. As result currently you can see javadoc of four Android builds.