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

Auto-generate API docs / highlight API classes #36

Open
Cervator opened this issue Sep 14, 2013 · 2 comments
Open

Auto-generate API docs / highlight API classes #36

Cervator opened this issue Sep 14, 2013 · 2 comments

Comments

@Cervator
Copy link
Member

With the new @API annotation @immortius introduced for API classes usable from moduels we might be able to flag those classes as special either in the Javadoc and/or by highlighting those on an API Doc page on the GitHub wiki (linking to the Javadoc per class)

If we really want to go crazy some sort of review process could detect changes to API classes to verify SemVer as accurate (not full auto there, but mark for review)

@immortius
Copy link

Note that @API is both a package and type annotation, and I'm generally applying it to packages.

@Cervator
Copy link
Member Author

Linking to MovingBlocks/TerasologyLauncher#273

Likely we'll need to publish to a gh-pages branch to generate a GitHub page. Wiki isn't a good home for static documentation, although is great for linking intelligently from tutorial pages to related Javadoc

@Cervator Cervator added backlog and removed backlog labels Nov 26, 2014
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

2 participants