Hello All.
We are running a project which includes not just JAVA source, but a lot of associated HTML code.
We would like to ensure consistent look-and-feel for our documentation by using JAVAdoc to parse both the .java files and .html files.
Has anyone done this? Can you help with the limitations of such a strategy?
Hello,
I have a similar problem like you, because I need to document some JavaScript files. Taglets can possibly do this job.
Taglets are extensions to javadoc. You can write your own Class which documents an external file and use this in javadoc.
http://java.sun.com/j2se/1.4/docs/tooldocs/javadoc/taglet/overview.html
Until now, there are very few taglets available.
Taglets are part of doclets, which are a *back* end to Javadoc,
not a front end. The front end parses only .java and .class
files -- it cannot parse JavaScript files.
Taglets and doclets enable documentation that has been
extracted from .java and .class files to be presented
in custom ways.
I don't see how you could use taglets to document JavaScript files.
-Doug
