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

Use JavaDoc comments for functions, variables description #2

@vovkab

Description

@vovkab

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";

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions