> From: Geoff Berry [mailto:[EMAIL PROTECTED]]
>
> Bernd Kreimeier <[EMAIL PROTECTED]> writes:
>
> > Last time I posted this URL, I asked about Classpath's javadoc.
> > Pretty please - somebody do the entire Java community a tremendous
> > service by implementing a decent pure Java javadoc replacement.
> > Using ANTLR, and James Clark's XP? DocBook instead of HTML?
> > XML generated from Java source instead of @result and @param?
> > Per-parameter comments? No more "package.html" and "doc-files/"?
> > Please tell me somebody is working on this, and that it's not
> > going to be a javadoc clone.
>
> I have the parsing side done as part of my compiler/repl. I can
> produce ASTs with doc comments attached to arbitrary nodes
> (e.g. classes, methods, fields, statements, whatever). The AST nodes
> also contain all of the information like parameter types/names, return
> types, thrown exceptions, etc.
>
> I have a proof-of-concept class that just prints this information out,
> but the sky's the limit with how you want to format it. If anyone is
> interested in hooking this up with the doclet API (or anything else
> for that matter) I can provide assistance, just drop me a note.
>
So the parser actually allows you to attach comments to fields and
statements? Cool! Curiosity: how is the linking to the statement done? I
assume we can link the doc-comment back to the filename/line number somehow?
How about the class+method/line number in method?
That will give our system immense potential.
If that's what it does, then I'll be glad to work on the JavaDoc enhancement
... some of the ideas we've come up with here are too cool to stay
unimplemented.
I am curious: just how tied to Java is this, besides being written in it?
What kind of work would it take to make it work with something like C/C++?
A generic system that could generate doc-comments and do cross-linking and
todo lists would be a very useful thing for other projects.
--John Keiser
