Frequently Asked Questions
Do I have to compile my source code to use JavaDoq?
Do I have to provide compiled classes to use JavaDoq?
Which version of Java source can JavaDoq process?
What runtime library does JavaDoq need?
Does JavaDoq need Java SDK (J2SE)?
Does JavaDoq need Java Compiler API?
Does JavaDoq need Eclipse JDT?
Has JavaDoq anything to do with JScripter?
Is there an Eclipse plugin for JavaDoq?
What is JavaDoq?
JavaDoq [java-docu] is a handy open source tool to convert Java source code into browsable HTML documents with JavaDoc style and Eclipse Look-And-Feel.
Whom is JavaDoq for?
Any Java developers.
Why JavaDoq?
The features you get with JavaDoq:
- Java key words colorized similar to Eclipse
- Source files organized in packages like JavaDoc
- Java identifiers cross referenced via hyper links
- Class nesting compatibility up to Java 6 code
- JavaDoc formal comments linked back to source code
- JavaCC and JJTree input files also parsed and linked
- Conventional overview.html and package.html files included
- Concise and well-documented pure OO source code
- Ant Task interface class provided
Is JavaDoq trying to replace JavaDoc?
Never. JavaDoc focuses on class hierarchy while JavaDoq handles source files especially for open source needs.
Does JavaDoq rely on JavaDoc?
No. They are totally separate.
Do I have to compile my source code to use JavaDoq?
Not necessarily but only valid source code can pass JavaDoq.
Do I have to provide compiled classes to use JavaDoq?
No. JavaDoq only scans and parses source files.
Which version of Java source can JavaDoq process?
Any valid Java source files including *.java, *.jt and *.jjt
What runtime library does JavaDoq need?
JRE 1.5 or above.
Does JavaDoq need Java SDK (J2SE)?
JRE 1.5 or above is sufficient.
Does JavaDoq need Java Compiler API?
No. JavaDoq only uses JavaCC to have generated its source code.
Does JavaDoq need Eclipse JDT?
No. JavaDoq only uses JavaCC to have generated its source code.
Is there any pitfalls?
Yes, of course. JavaDoq 1.0 currently only creates accurate links between Java types. I intend to build a full language model for future versions to possibly cover any Java identifiers including local variables.
Has JavaDoq anything to do with JScripter?
JavaDoq is originally developed solely by J.J.Liu (Jianjun Liu) for JScripter Libraries and now released as a separate tool in open source under GNU General Public License Version 3.
Is there any Eclipse plugins for JavaDoq?
Not for now. Ant building is quite enough.
JavaDoq
DOCUment JAVA In SourceDocumentation
Examples
Links
News
- Descripter was released on 2012/05/10
- JavaDoq 1.0 was released on 2011/09/10
- JScripter Libraries was updated on 2011/09/10
- JavaJavaScript was updated on 2011/09/10
- JRecompiler was updated on 2011/09/10