[antlr-interest] Documenting grammars

[Sam Harwell]

Why not create our own format that properly describes grammars?

We could group them by the Tokens file they reference to cover
lexer/parser/tree parser combinations. Documentation could include
formatted/highlighted rule text, comments, DFA statistics, and
thumbnails of the various rule diagrams linked to full-size versions.

Sam (Harwell)

-----Original Message-----
From: antlr-interest-bounces at antlr.org
[mailto:antlr-interest-bounces at antlr.org] On Behalf Of Sam
Barnett-Cormack
Sent: Monday, March 23, 2009 11:04 AM
To: Jim Idle
Cc: ANTLR Interest Mailing List
Subject: Re: [antlr-interest] Documenting grammars

Of course, it may be possible to re-use doxygen's *output* code.
However, I'm almost beginning to feel that there's a lack of a *truly*
language-independent documentation tool. The task I set myself would be
growing, but it wouldn't be so hard to develop an antlr-specific
documentor that is built with the future in mind to accept modular
input/output schemes. Reusing javadoc's output routines would still be
tempting. If I were starting from scratch, I'd work in Java.

Sam