Description
Hi, just started using documentation.js
and noticed it doesn't seem to output @see
tags when using the html
formatter.
For example, using __tests__/fixture/meta.input.js
/**
* This description is ignored because the method has a tagged description.
* @returns {number} numberone
* @description This function returns the number one.
* @see {@link http://github.com/|github}
* @see TestCase
* @see [markdown link](http://foo.com/)
* @version 1.0.0
* @since 2.0.0
* @copyright Tom MacWright
* @license BSD
*/
module.exports = function() {
// this returns 1
return 1;
};
The resulting HTML
output doesn't seem to have rendered any of the @see
:
docs.zip
-
What version of documentation.js are you using?:
5.3.5
andmaster
dev branch -
How are you running documentation.js (on the CLI, Node.js API, Grunt, other?):
./node_modules/.bin/documentation build src/** -f html -o docs
(5.3.5
)
./node_modules/.bin/documentation serve --watch src/** -f html
(5.3.5
)
./bin/documentation.js build __tests__/fixture/meta.input.js -f html -o docs
(inmaster
branch)
Just glancing at the source code this morning, this might have never been supported and I'm assuming it was. src/default_theme/index._ doesn't seem to reference the #sees
that's in the comments
collection element pass to the template:
[ { description: { type: 'root', children: [Array], position: [Object] },
tags:
[ [Object],
[Object],
[Object],
[Object],
[Object],
[Object],
[Object],
[Object],
[Object] ],
loc: SourceLocation { start: [Object], end: [Object] },
context:
{ loc: [Object],
file: '/Users/kwhittin/Documents/Projects/JS/documentation/__tests__/fixture/meta.input.js',
sortKey: '!/Users/kwhittin/Documents/Projects/JS/documentation/__tests__/fixture/meta.input.js 00000013' },
augments: [],
errors: [],
examples: [],
params: [],
properties: [],
returns: [ [Object] ],
sees: [ [Object], [Object], [Object] ],
throws: [],
todos: [],
version: '1.0.0',
since: '2.0.0',
copyright: { type: 'root', children: [Array], position: [Object] },
license: 'BSD',
name: 'meta.input',
kind: 'function',
members: { global: [], inner: [], instance: [], events: [], static: [] },
path: [ [Object] ],
namespace: 'meta.input' } ]