Skip to content

Commit da979fd

Browse files
committed
Update tag/function.js documentation
1 parent 71824f4 commit da979fd

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

tags/function.js

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,10 @@ var getParent = require("bit-docs-process-tags/get-parent"),
1313

1414
/**
1515
* @module {Object} bit-docs-js/tags/function @function
16-
*
1716
* @parent bit-docs-js/tags
1817
*
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.
2120
*
2221
* @signature `@function [NAME] [TITLE]`
2322
*
@@ -31,23 +30,23 @@ var getParent = require("bit-docs-process-tags/get-parent"),
3130
* }
3231
* @codeend
3332
*
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.
3735
*
3836
* @param {String} [TITLE] The title to be used for display purposes.
3937
*
4038
* @body
4139
*
4240
* ## Code Matching
4341
*
44-
* The `@function` type can be infered from code like the following:
42+
* The `@function` type can be inferred from code like the following:
4543
*
4644
* @codestart javascript
4745
* /**
4846
* * The foo function exists
4947
* *|
5048
* foo: function(){}
49+
*
5150
* /**
5251
* * The bar function exists
5352
* *|

0 commit comments

Comments
 (0)