[antlr-interest] ANTLR Javadocs

Terence Parr parrt at cs.usfca.edu
Tue Aug 25 16:37:01 PDT 2009


On Aug 25, 2009, at 2:19 PM, Sam Barnett-Cormack wrote:

> David-Sarah Hopwood wrote:
>> Terence Parr wrote:
>>> hi. not sure what's wrong with the doxygen..can you be more  
>>> specific?
>>
>> Suppose someone wants their javadoc implementation to include links
>> into ANTLR classes. They could run javadoc on the full ANTLR source,
>> or they could just use the "-link <url>" option of javadoc to point
>> to somewhere on the ANTLR site. The latter is much easier, and  
>> doesn't
>> require them to ship the ANTLR documentation with their own  
>> documentation.
>
> Specifically, it has to be javadoc because of the specific directoy
> structures and suchlike used by javadoc, including a specific file I
> forget the name of, that it uses to figure out which classes are under
> which URL.

thanks everyone. I see the issue now. Yes, ANTLR should have a  
standard documentation but unfortunately we have doxygen at the  
moment. since it is just Java, though, can I just run Java doc on  
everything and put it at a standard place on the website? It would  
have to include a version number as you say.

ter


More information about the antlr-interest mailing list