File tree Expand file tree Collapse file tree 1 file changed +6
-7
lines changed Expand file tree Collapse file tree 1 file changed +6
-7
lines changed Original file line number Diff line number Diff line change @@ -13,11 +13,10 @@ var getParent = require("bit-docs-process-tags/get-parent"),
13
13
14
14
/**
15
15
* @module {Object} bit-docs-js/tags/function @function
16
- *
17
16
* @parent bit-docs-js/tags
18
17
*
19
- * @description Specifies the comment is for a function. Use [bit-docs-js/tags/param @param] to
20
- * specify the arguments of a function.
18
+ * @description Specifies the comment is for a function. Use
19
+ * [bit-docs-js/tags/param] to specify the parameters of a function.
21
20
*
22
21
* @signature `@function [NAME] [TITLE]`
23
22
*
@@ -31,23 +30,23 @@ var getParent = require("bit-docs-process-tags/get-parent"),
31
30
* }
32
31
* @codeend
33
32
*
34
- * @param {String } [NAME] The name of the function. It should
35
- * be supplied if it can not be determined from the code block
36
- * following the comment.
33
+ * @param {String } [NAME] The name of the function. It should be supplied
34
+ * if it cannot be determined from the code block following the comment.
37
35
*
38
36
* @param {String } [TITLE] The title to be used for display purposes.
39
37
*
40
38
* @body
41
39
*
42
40
* ## Code Matching
43
41
*
44
- * The `@function` type can be infered from code like the following:
42
+ * The `@function` type can be inferred from code like the following:
45
43
*
46
44
* @codestart javascript
47
45
* /**
48
46
* * The foo function exists
49
47
* *|
50
48
* foo: function(){}
49
+ *
51
50
* /**
52
51
* * The bar function exists
53
52
* *|
You can’t perform that action at this time.
0 commit comments