what are the options of javadoc in droiddoc like -apixml ?

[Simon Liu]

I am trying to generate the documentation of my own package and also
the api xml for apicheck.
When I looked into the framework/base/Android.mk, I noticed that there
some options for javadoc are not supported by javadoc.

For example, in frameworks/base/Android.mk
400 LOCAL_DROIDDOC_OPTIONS:=\
401 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
402 -title "Android SDK" \
403 -proofread $(OUT_DOCS)/$(LOCAL_MODULE)-
proofread.txt \
404 -todo $(OUT_DOCS)/$(LOCAL_MODULE)-docs-todo.html \
405 -stubs $(TARGET_OUT_COMMON_INTERMEDIATES)/
JAVA_LIBRARIES/android_stubs_current_intermediates/src \
406 -apixml $(INTERNAL_PLATFORM_API_FILE) \
407 -sdkvalues $(OUT_DOCS) \
408 -warning 3 \
409 -hdf android.whichdoc offline

I think the -apixml option is used to generate the api xml file, but I
can't found the description of this option in javadoc help. The others
options like -templatedir in droiddoc.mk are also not found in javadoc
manpage.

I am confused what version of javadoc does Android build system used.

My java version is:
java version "1.5.0_19"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_19-b02)
Java HotSpot(TM) Server VM (build 1.5.0_19-b02, mixed mode)

Thank you.

[Fred Grott]

those are doclet commands..ie javadoc standard..

these are specific to the android project doclet I would imagine

Fred Grott
http://mobilebytes.wordpress.com

[Christopher Tate]

That's correct; the Android build uses a custom javadoc doclet called
"droiddoc", and this doclet has a number of specialized command line
flags. You can find its sources in build/tools/droiddoc .

The droiddoc tool does three major things. It handles the conversion
of Javadoc comments into HTML documentation (using Clearsilver), it
generates the SDK's stub version of android.jar for linking third
party code, and it produces the API description that is an input to
the "apicheck" verification tool.

--
chris tate
Android framework engineer

[Fred Grott]

Sounds like a very cool tool..

[Jean-Baptiste Queru]

It's very central - without it, there'd be no SDK (no documentation,
no library to link apps against, no backward compatibility).

JBQ

--
Jean-Baptiste M. "JBQ" Queru
Software Engineer, Android Open-Source Project, Google.

Questions sent directly to me that have no reason for being private
will likely get ignored or forwarded to a public forum with no further
warning.