Update jsdoc strings

This commit is contained in:
Sahat Yalkabov
2014-02-07 10:21:18 -05:00
parent f0c649145a
commit a456508e60
3 changed files with 22 additions and 21 deletions

View File

@ -398,6 +398,7 @@ exports.getTwilio = function(req, res, next) {
/**
* POST /api/twilio
* Twilio API example.
* @param telephone
*/
exports.postTwilio = function(req, res, next) {

View File

@ -15,9 +15,9 @@ exports.getContact = function(req, res) {
/**
* POST /contact
* Send a contact form via SendGrid.
* @param {string} email
* @param {string} name
* @param {string} message
* @param email
* @param name
* @param message
*/
exports.postContact = function(req, res) {

View File

@ -17,8 +17,8 @@ exports.getLogin = function(req, res) {
/**
* POST /login
* Sign in using email and password.
* @param {string} email
* @param {string} password
* @param email
* @param password
*/
exports.postLogin = function(req, res, next) {
@ -47,6 +47,16 @@ exports.postLogin = function(req, res, next) {
})(req, res, next);
};
/**
* GET /logout
* Log out.
*/
exports.logout = function(req, res) {
req.logout();
res.redirect('/');
};
/**
* GET /signup
* Signup page.
@ -62,8 +72,8 @@ exports.getSignup = function(req, res) {
/**
* POST /signup
* Create a new local account.
* @param {string} email
* @param {string} password
* @param email
* @param password
*/
exports.postSignup = function(req, res, next) {
@ -133,7 +143,7 @@ exports.postUpdateProfile = function(req, res, next) {
/**
* POST /account/password
* Update current password.
* @param {string} password
* @param password
*/
exports.postUpdatePassword = function(req, res, next) {
@ -163,7 +173,7 @@ exports.postUpdatePassword = function(req, res, next) {
/**
* POST /account/delete
* Delete user account.
* @param {string} id
* @param id - User ObjectId
*/
exports.postDeleteAccount = function(req, res, next) {
@ -177,8 +187,8 @@ exports.postDeleteAccount = function(req, res, next) {
/**
* GET /account/unlink/:provider
* Unlink OAuth2 provider from the current user.
* @param {string} provider
* @param {string} id
* @param provider
* @param id - User ObjectId
*/
exports.getOauthUnlink = function(req, res, next) {
@ -196,13 +206,3 @@ exports.getOauthUnlink = function(req, res, next) {
});
});
};
/**
* GET /logout
* Log out.
*/
exports.logout = function(req, res) {
req.logout();
res.redirect('/');
};