My favorites | Sign in
Project Home Downloads Wiki Issues Source
Project Information
Members
Featured
Wiki pages
Links

Javadox cross-references multiple javadoc documents together. The suffix "x" reads like the plurality form and means Xross-referenced javadocs.

To not remake the wheel, more and more java projects reuse other existing projects. However, the generated documents usually contains stuffs of current project only. This causes navigation interruption when referencing to other projects. Developers has to stop navigating and google for what package the return/parameter type is.

Although the javadoc generator do provide the --link and --linkoffline options to link to external documents, the required bootstraping process make them hard to maintain. As a result, only JDK are cross-referenced, which is quite useless for developers familiar to JDK already.

The javadox browser is a single-page-application that leverage client-side technologies to crossreferencing multiple javadoc documents together. No sepcial requirement on server-side, we can even run the brower in local machine.

This project is currently under prove-of-concept stage. Welcome to join the javadox-devel mailing list for discussion.

Powered by Google Project Hosting