|
1 | 1 | var _ = require("lodash");
|
| 2 | + |
2 | 3 | /**
|
3 | 4 | * @parent bit-docs-js/modules
|
4 |
| - * @module {function} bit-docs-js/process/code code |
| 5 | + * @module {function} bit-docs-js/process/code |
5 | 6 | *
|
6 |
| - * Process a code hint into properties on a `docObject`. |
| 7 | + * Process a code hint into properties on a [bit-docs/types/docObject]. |
7 | 8 | *
|
8 | 9 | * @signature `processCode(options, callback)`
|
9 | 10 | *
|
10 | 11 | * 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]. |
12 | 15 | *
|
13 | 16 | * @param {bit-docs/types/processOptions} options An options object that
|
14 | 17 | * contains the code to process.
|
15 | 18 | *
|
16 | 19 | * @param {function(bit-docs/types/docObject,bit-docs/types/docObject)} callback(newDoc,newScope)
|
17 | 20 | *
|
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. |
20 | 24 | *
|
21 | 25 | * @body
|
22 | 26 | *
|
23 | 27 | * ## Use
|
24 | 28 | *
|
25 |
| - * documentjs.process.code( |
| 29 | + * process.code( |
26 | 30 | * {code: "foo: function(){"},
|
27 | 31 | * function(newDoc){
|
28 | 32 | * newDoc.type //-> "function"
|
|
0 commit comments