Skip to content
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

@file overview comment not rendering #219

Closed
mysticaltech opened this issue Jul 23, 2020 · 1 comment
Closed

@file overview comment not rendering #219

mysticaltech opened this issue Jul 23, 2020 · 1 comment

Comments

@mysticaltech
Copy link

mysticaltech commented Jul 23, 2020

Hey folks, I have the following at the beginning of my source and I would expect it to render (it does with normal jsdoc) but it does not with jsdoc2md. Any ideas of how to make this render? Everything else renders but the first block with @file!

/**
 * @file The XYZ Library main file
 * @author Karim <[email protected]>
 * @copyright XYZ, inc
 * @version 0.1.0-alpha
 */

/**
 * Metrics string values
 * @enum {string}
 */
/** x value */
const metricsEnum = {
  x: 'x',
  /** y value */
  y: 'y',
}

@75lb
Copy link
Member

75lb commented Mar 25, 2021

duplicate of jsdoc2md/dmd#100

@75lb 75lb closed this as completed Mar 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants