Skip to content

@see not rendered in HTML formatter #1009

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
kWhittington opened this issue Feb 4, 2018 · 1 comment
Closed

@see not rendered in HTML formatter #1009

kWhittington opened this issue Feb 4, 2018 · 1 comment

Comments

@kWhittington
Copy link

kWhittington commented Feb 4, 2018

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:
meta_input_doc
docs.zip

  • What version of documentation.js are you using?:
    5.3.5 and master 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 (in master 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' } ]
@tmcw
Copy link
Member

tmcw commented Feb 10, 2018

Closing, tracked in the master tag support ticket: #9 - if you want to contribute a fix, please do.

@tmcw tmcw closed this as completed Feb 10, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants