gaspersic/freeCodeCamp
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update jsdoc strings

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

1
controllers/api.js
View File

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

6
controllers/contact.js
View File

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

36
controllers/user.js
View File

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