Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve hyperlinks of generated docs #38

Open
gradha opened this issue May 27, 2011 · 0 comments
Open

Improve hyperlinks of generated docs #38

gradha opened this issue May 27, 2011 · 0 comments

Comments

@gradha
Copy link

gradha commented May 27, 2011

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant