[antlr-interest] ANTLR Javadocs

[Sam Barnett-Cormack]

Jim Idle wrote:
> Ter,
> 
> Run
> 
> Mvn javadoc:javadoc
> 
> And look under target/site
> 
> I will make it part of the release cycle on my return from travel.

And note that the options from David-Sarah Hopwood can easily be set in 
Maven as well, and for best appearance will be. Maven does set several 
of them to sane defaults, including (I believe) the java api doc url, 
based on the source/target options set, and setting the header based on 
the maven project title, version, etc etc. Going back in time to do old 
ones would be a little harder - would basically require branching off 
the version control points for each release to add the required config, 
etc etc.

Sam

> On Aug 25, 2009, at 6:37 PM, Terence Parr <parrt at cs.usfca.edu> wrote:
> 
>>
>> 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
>>
>> List: http://www.antlr.org/mailman/listinfo/antlr-interest
>> Unsubscribe: 
>> http://www.antlr.org/mailman/options/antlr-interest/your-email-address


-- 
Sam Barnett-Cormack