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

Support Displaying @version Tag from JSDoc in Documentation #282

Open
gautam-jha opened this issue Nov 10, 2024 · 0 comments
Open

Support Displaying @version Tag from JSDoc in Documentation #282

gautam-jha opened this issue Nov 10, 2024 · 0 comments

Comments

@gautam-jha
Copy link

Problem Statement

I’m having trouble figuring out how to display the @version tag from JSDoc using web-component-analyzer (WCA). It seems like WCA might not support showing @version in the generated documentation. The @version tag is really useful for tracking the version of a component, property, or event, helping developers quickly identify which version they’re looking at. This feature would be particularly helpful for projects with frequent component updates, as it would allow version changes to be easily tracked within the documentation itself.

Feature Request

Add support for parsing and displaying the @version tag from JSDoc comments within the web-component-analyzer output. When a web component has a @version tag in its JSDoc, web-component-analyzer should capture and display this version information alongside other details in the generated documentation (e.g., in Markdown, HTML).

Example

JSDoc Input

/**
 * A button component that can be used in various places in the UI.
 *
 * @version 1.2.3
 * @tag button
 * @property {string} label - The label displayed on the button.
 */
class MyButton extends HTMLElement {
  // Component logic here
}

Desired Output (Markdown)

## MyButton

**Version:** 1.2.3

A button component that can be used in various places in the UI.

### Properties

- **foo** (string): The label displayed on the button.

Use Case

The addition of @version support would allow projects to track which version of each component is documented directly in the generated output. This would help developers understand version-specific changes without consulting external changelogs, improving clarity and streamlining the documentation process.

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

1 participant