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

API documentation wanted #16

Open
myabc opened this issue Nov 18, 2013 · 2 comments
Open

API documentation wanted #16

myabc opened this issue Nov 18, 2013 · 2 comments

Comments

@myabc
Copy link
Owner

myabc commented Nov 18, 2013

From [email protected] on August 02, 2009 09:26:14

Having some API documentation would help a lot, preferably javadoc, but a
simple wiki page will suffice. As it is, one downloads a .jar file and am
immediately stuck. What classes exist? What methods do they have?

It would be great if there were some way of finding out that's easier than
getting the source from git and then running javadoc on it.

Original issue: http://code.google.com/p/markdownj/issues/detail?id=13

@myabc
Copy link
Owner Author

myabc commented Nov 18, 2013

From alex.coles on August 30, 2009 12:12:11

Status: Started

@myabc
Copy link
Owner Author

myabc commented Nov 18, 2013

From [email protected] on February 13, 2011 14:11:30

It would give me great pleasure to have a documentation for the library. It would be fine to have both an API documentation and a short documentation about how getting started. I also could imagine to help with that if wanted.

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

No branches or pull requests

1 participant