Skip to content

Commit b4eea7a

Browse files
committed
WIP2
1 parent c41446d commit b4eea7a

File tree

3 files changed

+36
-32
lines changed

3 files changed

+36
-32
lines changed

tags/class.js

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,15 @@ var getParent = require("bit-docs-process-tags/get-parent"),
44
var funcMatch = /(?:([\w\.\$]+)|(["'][^"']+["']))\s*[=]\s*function\s?\(([^\)]*)/,
55
codeMatch = /([\w\.\$]+?).extend\(\s*["']([^"']*)["']/;
66

7-
/**
8-
* @constructor documentjs.tags.constructor @constructor
9-
* @hide
10-
* Document a constructor function.
11-
*
12-
* @signature `@constructor NAME [TITLE]`
13-
* @parent documentjs.tags
14-
*/
7+
/**
8+
* @module {bit-docs-process-tags/tag} bit-docs-js/tags/constructor @constructor
9+
* @parent bit-docs-js/tags
10+
* @hide
11+
*
12+
* Document a constructor function.
13+
*
14+
* @signature `@constructor NAME [TITLE]`
15+
*/
1516
module.exports = {
1617
add: function(line, curData, scope, docMap){
1718
console.warn("Using the @class directive. It is deprecated!");

tags/constructor.js

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,15 @@ var getParent = require("bit-docs-process-tags/get-parent"),
44
var funcMatch = /(?:([\w\.\$]+)|(["'][^"']+["']))\s*[=]\s*function\s?\(([^\)]*)/,
55
codeMatch = /([\w\.\$]+?).extend\(\s*["']([^"']*)["']/;
66

7-
/**
8-
* @constructor documentjs.tags.constructor @constructor
9-
* @hide
10-
* Document a constructor function.
11-
*
12-
* @signature `@constructor NAME [TITLE]`
13-
* @parent documentjs.tags
14-
*/
7+
/**
8+
* @module {bit-docs-process-tags/tag} bit-docs-js/tags/constructor @constructor
9+
* @parent bit-docs-js/tags
10+
* @hide
11+
*
12+
* Document a constructor function.
13+
*
14+
* @signature `@constructor NAME [TITLE]`
15+
*/
1516
module.exports = {
1617
codeMatch: function(code){
1718
return codeMatch.test(code);

tags/module.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
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
43

54
Declares the export value for a module.
65

@@ -14,8 +13,9 @@ Declares the export value for a module.
1413
*|
1514
@codeend
1615

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}`.
1919

2020
@param {String} NAME The name of the type.
2121

@@ -33,7 +33,7 @@ exports you might use as one of the following:
3333
```
3434
/**
3535
* @module {function} multi/util/add
36-
* @parent multi.modules
36+
* @parent multi/modules
3737
*
3838
* Adds two numbers together.
3939
*
@@ -42,9 +42,8 @@ exports you might use as one of the following:
4242
* @param {Number} first The first number.
4343
* @param {Number} second The second number to add.
4444
* @return {Number} The two numbers added together.
45-
*
4645
*/
47-
module.exports = function(first, second){
46+
module.exports = function(first, second) {
4847
return first+second;
4948
};
5049
```
@@ -54,42 +53,45 @@ module.exports = function(first, second){
5453
```
5554
/**
5655
* @module {Module} multi/util/date-helpers
57-
* @parent multi.modules
56+
* @parent multi/modules
5857
*
5958
* Provides an object of date helpers.
6059
*/
61-
//
60+
6261
/**
6362
* @function tomorrow
6463
* Provides the start time of tomorrow.
6564
*/
66-
exports.tomorrow = function(){ };
65+
exports.tomorrow = function() { ... };
66+
6767
/**
6868
* @function yesterday
6969
* Provides the start time of yesterday.
7070
*/
71-
exports.yesterday = function(){ };
71+
exports.yesterday = function() { ... };
7272
```
7373

7474
#### A single constructor function export
7575

7676
```
7777
/**
7878
* @module {function(new:multi/lib/graph)} multi/lib/graph
79-
* @parent multi.modules
79+
* @parent multi/modules
8080
*
8181
* @signature `new Graph(graphData)`
8282
* @param {Object} graphData
8383
*/
84-
function Graph(graphData){ … }
84+
function Graph(graphData) { ... }
85+
8586
/**
8687
* @prototype
8788
*/
8889
Graph.prototype = {
8990
/**
9091
* @function toChart
9192
*/
92-
toChart: function(){}
93+
toChart: function() { ...}
9394
};
95+
9496
module.exports = Graph;
95-
```
97+
```

0 commit comments

Comments
 (0)