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.

Sign up for GitHub

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

Jump to bottom

javadoc #133

Closed
Davidiusdadi opened this issue Nov 1, 2012 · 2 comments
Closed

javadoc #133

Davidiusdadi opened this issue Nov 1, 2012 · 2 comments
Assignees
@marci4
Labels
Documentation Wanted
Milestone
Release 1.3.5

Comments

@Davidiusdadi
Copy link
Collaborator

The javadoc should not be in the repository itself.

The readme.markdown should contain to a link to the javadoc instead.

Additionally the javadoc is very incomplete...
Davidiusdadi added a commit to Davidiusdadi/Java-WebSocket that referenced this issue Nov 1, 2012
@Davidiusdadi
removed old javadoc permanently (TooTallNate#133)
1de0ffe
@hanxue
Copy link

hanxue commented Jan 13, 2014

The javadocs are excluded on purpose. If you look at .gitignore, the /doc/ directory is excluded. https://github.com/TooTallNate/Java-WebSocket/blob/master/.gitignore

You can generate it anytime by running ant doc. If you want an online copy, I have a javadocs branch https://github.com/hanxue/Java-WebSocket/tree/javadocs/doc

maakolk pushed a commit to maakolk/Java-WebSocket that referenced this issue Mar 5, 2017
@Davidiusdadi
removed old javadoc permanently (TooTallNate#133)
a2a647a
@marci4
Copy link
Collaborator

marci4 commented Jun 6, 2017

Always adding javadocs for new features/refactored methods, but cant to this for old ones!

Added link in readme

@marci4 marci4 closed this as completed Jun 6, 2017
@marci4 marci4 mentioned this issue Jun 6, 2017
Merged
@marci4 marci4 added this to the Release 1.3.5 milestone Jun 6, 2017
@marci4 marci4 self-assigned this Jun 6, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@marci4 marci4

Labels
Documentation Wanted
Projects
None yet
Milestone
Release 1.3.5
Development

No branches or pull requests
3 participants
@hanxue @Davidiusdadi @marci4