Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Source for JavaDoc #105

Open
bobjacobsen opened this issue Feb 27, 2018 · 4 comments
Open

Source for JavaDoc #105

bobjacobsen opened this issue Feb 27, 2018 · 4 comments

Comments

@bobjacobsen
Copy link

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
Copy link
Owner

nyholku commented Feb 27, 2018

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

@bobjacobsen
Copy link
Author

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

@nyholku
Copy link
Owner

nyholku commented Feb 27, 2018

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
Copy link
Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants