CodeTagBlock typedef
For .js
files, bit-docs-js will find all block comments (/**
until
*/
), remove leading *
s and whitespace, and pass
CodeTagBlock to bit-docs-js/process/codeAndComment.
Use
Like TagBlock but CodeTagBlocks come from FileSource block comments when they contain CodeTags:
// my-project/lib/index.js
/**
* @tag ...
*/
Source files can have multiple block comments containing CodeTags:
// my-project/lib/helper.js
/**
* @tag1 ...
* @tag2 ...
* ...
* ...
*/
var codeLine = 'here';
/**
* @tag4 ...
*/
var moreCode = 'more';
[bit-docs-js/process/get_comment] will strip the *
s and return two
CodeTagBlocks:
[
'@tag1 ...',
'@tag2 ...',
'...',
'...',
]
and
// second block
[
'@tag4 ...'
]
These CodeTagBlocks will be used by bit-docs-js/process/codeAndComment.