Skip to content
This repository has been archived by the owner on Apr 5, 2022. It is now read-only.

Use JavaDoc comments for functions, variables description #2

Open
vovkab opened this issue Sep 21, 2012 · 0 comments
Open

Use JavaDoc comments for functions, variables description #2

vovkab opened this issue Sep 21, 2012 · 0 comments

Comments

@vovkab
Copy link

vovkab commented Sep 21, 2012

Please use JavaDoc comments, to describe functions, variables and etc in your code.
Right now you use comments, which are obviously not a javadoc comments, and you can't get description of functions with this way.

Here how it looks right now:
/* Broadcast when the api has successfully connected to the server.
* You may now call enableBumping to enable bumping and matching.
*/
public static final String CONNECTED = "com.bumptech.api.connected";

Should be:
/**
* Broadcast when the api has successfully connected to the server.
* You may now call enableBumping to enable bumping and matching.
*/
public static final String CONNECTED = "com.bumptech.api.connected";

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

No branches or pull requests

1 participant