Skip to content

Commit 55252da

Browse files
committed
[doc] jsdoc fixes
1 parent 1b523ba commit 55252da

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

api/config.sample.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ var countlyConfig = {
116116
*/
117117
fileStorage: "fs",
118118
/**
119-
*Specifies after how long time configurations are reloded from data base. Default value is 10000 (10 seconds)
119+
* Specifies after how long time configurations are reloded from data base. Default value is 10000 (10 seconds)
120120
* @type {integer} [default=10000]
121121
**/
122122
reloadConfigAfter: 10000,

api/configextender.js

+5-5
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,11 @@ const OVERRIDES = {
4747
/**
4848
* Digs one level down in config document
4949
*
50-
* @param {[type]} config [description]
51-
* @param {[type]} over [description]
52-
* @param {[type]} name [description]
53-
* @param {[type]} value [description]
54-
* @return {[type]} [description]
50+
* @param {object} config - config to traverse
51+
* @param {object} over - override object
52+
* @param {string} name - name of config to override
53+
* @param {varies} value - value to set to config
54+
* @return {object} recursive config modification
5555
*/
5656
function dig(config, over, name, value) {
5757
let comps = name.split('_');

api/parts/data/cache.js

+5-5
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ const CENTRAL = 'cache', OP = {INIT: 'i', PURGE: 'p', READ: 'r', WRITE: 'w', UPD
1414
// job removal from cache: {o: 0, k: 'ObjectId', g: 'jobs'}
1515

1616
/**
17-
* asd
18-
* @param {[type]} obj [description]
19-
* @param {[type]} is [description]
20-
* @param {[type]} value [description]
21-
* @return {[type]} [description]
17+
* Get value in nested object
18+
* @param {object} obj - object to checl
19+
* @param {string|array} is - keys for nested value
20+
* @param {any} value - if provided acts as setter setting this value in nested object
21+
* @return {varies} returns value in provided key in nested object
2222
*/
2323
const dot = function(obj, is, value) {
2424
if (typeof is === 'string') {

0 commit comments

Comments
 (0)