[antlr-interest] ANTLR Javadocs

[Sam Barnett-Cormack]

Gavin Lambert wrote:
> At 07:31 26/08/2009, David-Sarah Hopwood wrote:
>  >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.
> 
> For that to be correct, though, you'd have to link to a specific 
> version of the docs.  (ie. the site would have to have different 
> URLs for the 3.1.0 docs vs. the 3.1.1 docs, etc).
> 
> Seems simpler just to include them yourself, if you need to.

It's a matter of taste, but most java library/runtime projects seem to 
provide online docs. Given that they aren't huge, it's not usually much 
bother for a project website to include them, even for every release. 
This is especially true when compared with the bother for *every* 
project that'll use it. StringTemplate has online javadocs, the Java 
Platform does (obviously), so does, for example, junit. And, well, quite 
a lot of stuff.

-- 
Sam Barnett-Cormack