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

Remove unused doc directives related to categories. #3565

Closed
srawlins opened this issue Nov 1, 2023 · 0 comments
Closed

Remove unused doc directives related to categories. #3565

srawlins opened this issue Nov 1, 2023 · 0 comments
Assignees
Labels
type-tech-debt Issues that slow or block desirable development paths for Dartdoc, or create such problems for users

Comments

@srawlins
Copy link
Member

srawlins commented Nov 1, 2023

The categories feature has a number of doc directives that have only ever been half supported: {@api}, {@samples}, and {@image}. Dartdoc only goes so far as to relay data from these directives into a categories.json file (see generateCategoryJson), but they aren't used in the web side. (Maybe we just needed to make them available for custom templates?)

Anyhow I think we can now drop support for all three. The analyzer now parses directives and reports when it sees an "unknown" directive. It does not have support for these three directives, and we have not seen any bugs that it reports their use.

@srawlins srawlins added the type-tech-debt Issues that slow or block desirable development paths for Dartdoc, or create such problems for users label Nov 1, 2023
@kallentu kallentu self-assigned this Nov 1, 2023
@kallentu kallentu closed this as completed Nov 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type-tech-debt Issues that slow or block desirable development paths for Dartdoc, or create such problems for users
Projects
None yet
Development

No branches or pull requests

2 participants