Skip to content

Commit 9d2cf67

Browse files
committed
Update docs in /process
1 parent 12f3258 commit 9d2cf67

File tree

2 files changed

+16
-10
lines changed

2 files changed

+16
-10
lines changed

process/code.js

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,32 @@
11
var _ = require("lodash");
2+
23
/**
34
* @parent bit-docs-js/modules
4-
* @module {function} bit-docs-js/process/code code
5+
* @module {function} bit-docs-js/process/code
56
*
6-
* Process a code hint into properties on a `docObject`.
7+
* Process a code hint into properties on a [bit-docs/types/docObject].
78
*
89
* @signature `processCode(options, callback)`
910
*
1011
* Using the `options.code`, and `options.tags`, processes the code into
11-
* properties on a docObject. The `callback` is called with the new docObject.
12+
* properties on a [bit-docs/types/docObject].
13+
*
14+
* The `callback` is called with the new [bit-docs/types/docObject].
1215
*
1316
* @param {bit-docs/types/processOptions} options An options object that
1417
* contains the code to process.
1518
*
1619
* @param {function(bit-docs/types/docObject,bit-docs/types/docObject)} callback(newDoc,newScope)
1720
*
18-
* A function that is called back with a docObject created from the code and
19-
* the scope `docObject`. If no docObject is created, `newDoc` will be null.
21+
* A function that is called back with a [bit-docs/types/docObject] created
22+
* from the code and the scope `docObject`. If no [bit-docs/types/docObject] is
23+
* created, `newDoc` will be null.
2024
*
2125
* @body
2226
*
2327
* ## Use
2428
*
25-
* documentjs.process.code(
29+
* process.code(
2630
* {code: "foo: function(){"},
2731
* function(newDoc){
2832
* newDoc.type //-> "function"

process/code_and_comment.js

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,21 @@ var typeCheckReg = /^\s*@(\w+)/;
55

66
/**
77
* @parent bit-docs-js/modules
8-
* @module {function} bit-docs-js/process/codeAndComment codeAndComment
8+
* @module {function} bit-docs-js/process/codeAndComment
99
*
1010
* @signature `processCodeAndComment(options, callback)`
1111
*
12-
* Processes a code suggestion and then a comment and produces a docObject.
12+
* Processes a code suggestion and then a comment and produces a
13+
* [bit-docs/types/docObject].
1314
*
1415
* @param {bit-docs/types/processOptions} options An options object that
1516
* contains the code and comment to process.
1617
*
1718
* @param {function(bit-docs/types/docObject,bit-docs/types/docObject)} callback(newDoc,newScope)
1819
*
19-
* A function that is called back with a docObject created from the code and
20-
* the scope `docObject`. If no docObject is created, `newDoc` will be null.
20+
* A function that is called back with a [bit-docs/types/docObject] created
21+
* from the code and the scope `docObject`. If no [bit-docs/types/docObject] is
22+
* created, `newDoc` will be null.
2123
*
2224
* @option newDoc the new documentation object
2325
* @option newScope the new scope

0 commit comments

Comments
 (0)