efmarshall / h2database

Automatically exported from code.google.com/p/h2database
0 stars 0 forks source link

Online API documentation doesn't include "package-list" file #525

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago
The file mentioned in the title is necessary for the javadoc tool to link H2 
API documentation to other API documentations. It should be at 
"http://www.h2database.com/javadoc/package-list"

Original issue reported on code.google.com by tal.liron on 17 Nov 2013 at 5:49

GoogleCodeExporter commented 9 years ago
Hi,

What do you mean with "link H2 API documentation to other API documentations"?

The javadocs at the website at http://www.h2database.com/javadoc are 
non-standard (using a custom doclet). If you want to include the docs with 
another product (but why would you do that?), you could run javadoc yourself.

Original comment by thomas.t...@gmail.com on 21 Nov 2013 at 1:54

GoogleCodeExporter commented 9 years ago
Well, since you already have the documentation online, why not have mine link 
to yours? My project uses some H2 classes, so it would be nice for people who 
browse my project to easily move to yours where appropriate.

The problem is that this won't easily work right now. The JavaDoc tool expects 
a "package-list" file to exist at the root. Could you possibly switch to a more 
standard doclet?

Original comment by tal.liron on 21 Nov 2013 at 4:10

GoogleCodeExporter commented 9 years ago
> Could you possibly switch to a more standard doclet?

Well, I like the Javadocs the way they are. I think they look better than the 
default doclet output.

> Well, since you already have the documentation online, why not have mine link 
to yours?

To be honest, I'm not quite sure why you would want to link from your Javadocs 
to the H2 Javadocs.

But as far as I understand, you could already do that, if you javadoc yourself 
on the H2 source code, to generate the package-list.

Setting to wont fix for now.

Original comment by thomas.t...@gmail.com on 13 Dec 2013 at 8:17