droid-fu icon indicating copy to clipboard operation
droid-fu copied to clipboard

Improve hyperlinks of generated docs

Open gradha opened this issue 14 years ago • 0 comments

The online docs available at http://kaeppler.github.com/droid-fu/ can be improved by hyperlinking them to the android reference docs where appropriate. This can be done using the -link or -linkoffline parameters of the javadoc tool, as documented at http://stackoverflow.com/questions/2818204/how-to-generate-links-to-the-android-classes-reference-in-javadoc and the javadoc man page. For instance, when I generate my own local version of the droid-fu documentation, I use the following bash script:

#!/bin/sh

javadoc -sourcepath ../droid-fu/src/main/java/ \
    -linkoffline http://d.android.com/reference \
    file:/Users/gradha/instalacion_manual/android-sdk-r10-mac_x86/docs/reference \
    -classpath .:/Users/gradha/instalacion_manual/android-sdk-r10-mac_x86/platforms/android-7/android.jar \
    -subpackages com &&
    open index.html

This script is stored inside my project checkout directory, and hence the relative paths for sourcepath to find the original droid-fu checkout. The generated docs will now contain hyperlinks to the android classes, making reading the documentation much comfortable.

gradha avatar May 27 '11 07:05 gradha