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

Add our annotations to the API docs #2159

Open
Cervator opened this issue Feb 7, 2016 · 0 comments
Open

Add our annotations to the API docs #2159

Cervator opened this issue Feb 7, 2016 · 0 comments
Labels
Category: Build/CI Requests, Issues and Changes targeting gradle, groovy, Jenkins, etc. Category: Doc Requests, Issues and Changes targeting javadoc and module documentation

Comments

@Cervator
Copy link
Member

Cervator commented Feb 7, 2016

Follow-up after #2143 and part of #1975

We now list all @API flagged classes & packages + our whitelist. One remaining thing I think we should highlight in its own section are our custom annotations like @Command

I think most/all are already covered by package declarations like org.terasology.logic.console.commandSystem.annotations (PACKAGE) but I think they deserve individual mention as available annotations so we can have direct links to the javadoc for each annotation right on the main page.

This could perhaps be argued better as its own export since some annotations might only make sense in the engine when configuring some things. I am unsure. I see 44 annotations at present.

After this is complete the Modding API page in the wiki should be updated, just as after #2143 (which I did before submitting this)

Pinging @MaloJaffre if interested :-)

@Cervator Cervator added Category: Doc Requests, Issues and Changes targeting javadoc and module documentation Category: Build/CI Requests, Issues and Changes targeting gradle, groovy, Jenkins, etc. labels Feb 7, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Build/CI Requests, Issues and Changes targeting gradle, groovy, Jenkins, etc. Category: Doc Requests, Issues and Changes targeting javadoc and module documentation
Projects
None yet
Development

No branches or pull requests

2 participants