File tree Expand file tree Collapse file tree 6 files changed +13
-12
lines changed Expand file tree Collapse file tree 6 files changed +13
-12
lines changed Original file line number Diff line number Diff line change @@ -6,7 +6,7 @@ var _ = require('lodash');
6
6
/**
7
7
* @hide
8
8
* @parent bit-docs-process-tags/tags
9
- * @module {bit-docs-js /tag} bit-docs-process-tags/tags/_default @_default
9
+ * @module {bit-docs/types /tag} bit-docs-process-tags/tags/_default @_default
10
10
*
11
11
* The default tag behavior when `@TAG` begins a line, but no tag is defined
12
12
* for `TAG`.
Original file line number Diff line number Diff line change 1
1
/**
2
2
* @parent bit-docs-process-tags/tags
3
- * @module {bit-docs-js /tag} bit-docs-process-tags/tags/add @add
3
+ * @module {bit-docs/types /tag} bit-docs-process-tags/tags/add @add
4
4
*
5
5
* @description
6
6
*
21
21
* not have to write out a full name and [bit-docs-process-tags/tags/parent]
22
22
* tag.
23
23
*
24
- * In the following example, a docObject named `lib.Component.prototype.plugin`
25
- * and `lib.Component.prototype.draw` will be created, each with
26
- * `lib.Component.prototype` as their parent.
24
+ * In the following example, a [bit-docs/types/ docObject] named
25
+ * `lib.Component.prototype.plugin` and `lib.Component.prototype.draw` will be
26
+ * created, each with `lib.Component.prototype` as their parent.
27
27
*
28
28
* @codestart javascript
29
29
* /** @@add lib.Component.prototype *|
Original file line number Diff line number Diff line change @@ -3,7 +3,7 @@ var endHTMLComment = /\s*-->/;
3
3
4
4
/**
5
5
* @parent bit-docs-process-tags/tags
6
- * @module {bit-docs-js /tag} bit-docs-process-tags/tags/body @body
6
+ * @module {bit-docs/types /tag} bit-docs-process-tags/tags/body @body
7
7
*
8
8
* @description
9
9
*
Original file line number Diff line number Diff line change 1
1
/**
2
2
* @parent bit-docs-process-tags/tags
3
- * @module {bit-docs-js /tag} bit-docs-process-tags/tags/description @description
3
+ * @module {bit-docs/types /tag} bit-docs-process-tags/tags/description @description
4
4
*
5
5
* @description
6
6
*
20
20
*
21
21
* The description of a [bit-docs/types/docObject] is displayed at the top of
22
22
* an html page generated with the
23
- * [bit-docs-generate-html default html generator].
23
+ * [bit-docs-generate-html default html generator]. It also appears in the
24
+ * `title` attribute of links.
24
25
*
25
26
* In the following example, `@description` stops content from being added to
26
27
* [bit-docs-js/tags/param], and instead makes content be added to the
Original file line number Diff line number Diff line change 1
1
/**
2
2
* @parent bit-docs-process-tags/tags
3
- * @module {bit-docs-js /tag} bit-docs-process-tags/tags/hide @hide
3
+ * @module {bit-docs/types /tag} bit-docs-process-tags/tags/hide @hide
4
4
*
5
5
* Hides the comment from the navigation.
6
6
*
30
30
* *|
31
31
* @codeend
32
32
*
33
- * This a `hideSection` property to [bit-docs/types/docObject] where `Section`
34
- * is the capitalized `SECTION` name passed to `@hide`.
33
+ * This adds a `hideSection` property to [bit-docs/types/docObject] where
34
+ * `Section` is the capitalized `SECTION` name passed to `@hide`.
35
35
*/
36
36
module . exports = {
37
37
add : function ( line ) {
Original file line number Diff line number Diff line change 1
1
/**
2
2
* @parent bit-docs-process-tags/tags
3
- * @module {bit-docs-js /tag} bit-docs-process-tags/tags/parent @parent
3
+ * @module {bit-docs/types /tag} bit-docs-process-tags/tags/parent @parent
4
4
*
5
5
* Specifies the parent [bit-docs/types/docObject]'s name. The current
6
6
* docObject will be displayed under the the parent in the navigation.
You can’t perform that action at this time.
0 commit comments