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

JSDOC: API should use @callback tag for all callback functions #313

Open
billreed63 opened this issue Aug 25, 2016 · 0 comments
Open

JSDOC: API should use @callback tag for all callback functions #313

billreed63 opened this issue Aug 25, 2016 · 0 comments

Comments

@billreed63
Copy link
Collaborator

billreed63 commented Aug 25, 2016

/**
 * @class
 */
function Requester() {}

/**
 * Send a request.
 * @param {Requester~requestCallback} cb - The callback that handles the response.
 */
Requester.prototype.send = function(cb) {
    // code
};

/**
 * This callback is displayed as part of the Requester class.
 * @callback Requester~requestCallback
 * @param {number} responseCode
 * @param {string} responseMessage
 */

http://usejsdoc.org/tags-callback.html

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