search

nyholku / purejavacomm

Pure Java implementation of JavaComm SerialPort
http://www.sparetimelabs.com/purejavacomm/index.html
BSD 3-Clause "New" or "Revised" License
367 stars 146 forks source link

Source for JavaDoc #105

Open bobjacobsen opened 6 years ago

bobjacobsen commented 6 years ago

The JMRI project uses purejavacomm, which is great.

We'd like to link our Javadoc to the referenced purejavacomm classes. Our Ant builds try to use this URL:

http://static.javadoc.io/com.github.purejavacomm/purejavacomm/1.0.1.RELEASE/

but the Javadocs at the location aren't in the right format for automated linking.

Is there a better Javadoc URL to use?

Thanks!

nyholku commented 6 years ago

Where did you get this javadoc? I don't think the current build system produces javadocs?

bobjacobsen commented 6 years ago

Found it via Google. The human-readable version is here.

nyholku commented 6 years ago

I see. I don't know how that is generated and why it is not suitable for you. If you find out and there is something little I need to do to help you out I can have a look at that.

bobjacobsen commented 6 years ago

Not sure how it's generated either. The usual mode for Javadoc is to just generate it and put the files up on a web server somewhere. See this example. The Java doclet knows how to navigate that to link to it.

The javadoc.io one is more of a dynamic web site, which seems to generate pages on the fly. Great for browsing, but you can't deep link to a particular file that documents a particular class.

If you have your javadoc up somewhere that's got a URL, that's all we need. Otherwise, we can just skip it. Thanks for considering it. And thanks very much for PureJavaComm, it's great.