Skip to content

Commit efe82ab

Browse files
committed
build: minor code comment cleanup
1 parent fe2d11b commit efe82ab

File tree

2 files changed

+14
-5
lines changed

2 files changed

+14
-5
lines changed

index.js

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
/*!
22
* cookie-parser
3+
* Copyright(c) 2014 TJ Holowaychuk
34
* MIT Licensed
45
*/
56

67
/**
78
* Module dependencies.
9+
* @private
810
*/
911

1012
var cookie = require('cookie');
@@ -17,7 +19,7 @@ var parse = require('./lib/parse');
1719
* @param {String} [secret]
1820
* @param {Object} [options]
1921
* @return {Function}
20-
* @api public
22+
* @public
2123
*/
2224

2325
exports = module.exports = function cookieParser(secret, options){
@@ -51,6 +53,7 @@ exports = module.exports = function cookieParser(secret, options){
5153

5254
/**
5355
* Export parsing functions.
56+
* @public
5457
*/
5558

5659
exports.JSONCookie = parse.JSONCookie;

lib/parse.js

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
/*!
2+
* cookie-parser
3+
* Copyright(c) 2014 TJ Holowaychuk
4+
* MIT Licensed
5+
*/
6+
17
var signature = require('cookie-signature');
28

39
/**
@@ -7,7 +13,7 @@ var signature = require('cookie-signature');
713
*
814
* @param {Object} obj
915
* @return {Object}
10-
* @api private
16+
* @private
1117
*/
1218

1319
exports.signedCookies = function(obj, secret){
@@ -37,7 +43,7 @@ exports.signedCookies = function(obj, secret){
3743
* @param {String} str signed cookie string
3844
* @param {String} secret
3945
* @return {String} decoded value
40-
* @api private
46+
* @private
4147
*/
4248

4349
exports.signedCookie = function(str, secret){
@@ -51,7 +57,7 @@ exports.signedCookie = function(str, secret){
5157
*
5258
* @param {Object} obj
5359
* @return {Object}
54-
* @api private
60+
* @private
5561
*/
5662

5763
exports.JSONCookies = function(obj){
@@ -76,7 +82,7 @@ exports.JSONCookies = function(obj){
7682
*
7783
* @param {String} str
7884
* @return {Object} Parsed object or null if not json cookie
79-
* @api private
85+
* @private
8086
*/
8187

8288
exports.JSONCookie = function(str) {

0 commit comments

Comments
 (0)