Skip to content

Commit fe80c1d

Browse files
committed
Update docs for /tags
1 parent 4084e2d commit fe80c1d

File tree

6 files changed

+13
-12
lines changed

6 files changed

+13
-12
lines changed

tags/_default.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ var _ = require('lodash');
66
/**
77
* @hide
88
* @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
1010
*
1111
* The default tag behavior when `@TAG` begins a line, but no tag is defined
1212
* for `TAG`.

tags/add.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* @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
44
*
55
* @description
66
*
@@ -21,9 +21,9 @@
2121
* not have to write out a full name and [bit-docs-process-tags/tags/parent]
2222
* tag.
2323
*
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.
2727
*
2828
* @codestart javascript
2929
* /** @@add lib.Component.prototype *|

tags/body.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ var endHTMLComment = /\s*-->/;
33

44
/**
55
* @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
77
*
88
* @description
99
*

tags/description.js

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* @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
44
*
55
* @description
66
*
@@ -20,7 +20,8 @@
2020
*
2121
* The description of a [bit-docs/types/docObject] is displayed at the top of
2222
* 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.
2425
*
2526
* In the following example, `@description` stops content from being added to
2627
* [bit-docs-js/tags/param], and instead makes content be added to the

tags/hide.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* @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
44
*
55
* Hides the comment from the navigation.
66
*
@@ -30,8 +30,8 @@
3030
* *|
3131
* @codeend
3232
*
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`.
3535
*/
3636
module.exports = {
3737
add: function( line ) {

tags/parent.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* @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
44
*
55
* Specifies the parent [bit-docs/types/docObject]'s name. The current
66
* docObject will be displayed under the the parent in the navigation.

0 commit comments

Comments
 (0)