1
- @constructor documentjs.tags.module @module
2
- @tag documentation
3
- @parent documentjs.tags
1
+ @module {bit-docs-process-tags/tag} bit-docs-js/tags/module @module
2
+ @parent bit-docs-js/tags
4
3
5
4
Declares the export value for a module.
6
5
@@ -14,8 +13,9 @@ Declares the export value for a module.
14
13
* |
15
14
@codeend
16
15
17
- @param {documentjs.typeExpression} [ TYPE] A [ documentjs.typeExpression type expression] . This
18
- is typically an object specified like: ` {{}} ` or a function like ` {function} ` .
16
+ @param {bit-docs-type-annotate/typeExpression} [ TYPE] A
17
+ [ bit-docs-type-annotate/typeExpression type expression] . This is typically an
18
+ object specified like: ` {{}} ` or a function like ` {function} ` .
19
19
20
20
@param {String} NAME The name of the type.
21
21
@@ -33,7 +33,7 @@ exports you might use as one of the following:
33
33
```
34
34
/**
35
35
* @module {function} multi/util/add
36
- * @parent multi. modules
36
+ * @parent multi/ modules
37
37
*
38
38
* Adds two numbers together.
39
39
*
@@ -42,9 +42,8 @@ exports you might use as one of the following:
42
42
* @param {Number} first The first number.
43
43
* @param {Number} second The second number to add.
44
44
* @return {Number} The two numbers added together.
45
- *
46
45
*/
47
- module.exports = function(first, second){
46
+ module.exports = function(first, second) {
48
47
return first+second;
49
48
};
50
49
```
@@ -54,42 +53,45 @@ module.exports = function(first, second){
54
53
```
55
54
/**
56
55
* @module {Module} multi/util/date-helpers
57
- * @parent multi. modules
56
+ * @parent multi/ modules
58
57
*
59
58
* Provides an object of date helpers.
60
59
*/
61
- //
60
+
62
61
/**
63
62
* @function tomorrow
64
63
* Provides the start time of tomorrow.
65
64
*/
66
- exports.tomorrow = function(){ };
65
+ exports.tomorrow = function() { ... };
66
+
67
67
/**
68
68
* @function yesterday
69
69
* Provides the start time of yesterday.
70
70
*/
71
- exports.yesterday = function(){ };
71
+ exports.yesterday = function() { ... };
72
72
```
73
73
74
74
#### A single constructor function export
75
75
76
76
```
77
77
/**
78
78
* @module {function(new:multi/lib/graph)} multi/lib/graph
79
- * @parent multi. modules
79
+ * @parent multi/ modules
80
80
*
81
81
* @signature `new Graph(graphData)`
82
82
* @param {Object} graphData
83
83
*/
84
- function Graph(graphData){ … }
84
+ function Graph(graphData) { ... }
85
+
85
86
/**
86
87
* @prototype
87
88
*/
88
89
Graph.prototype = {
89
90
/**
90
91
* @function toChart
91
92
*/
92
- toChart: function(){ }
93
+ toChart: function() { ... }
93
94
};
95
+
94
96
module.exports = Graph;
95
- ```
97
+ ```
0 commit comments