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

Have an option to generate docs without categories #4012

Open
HosseinYousefi opened this issue Mar 3, 2025 · 2 comments
Open

Have an option to generate docs without categories #4012

HosseinYousefi opened this issue Mar 3, 2025 · 2 comments

Comments

@HosseinYousefi
Copy link
Member

Currently in order to generate general docs about the usage of a package, we're using categories. These categories are then generated as "topics" only if we actually use them inside the doc comments like {@category xyz}. It would be nice if we have an option to have general docs that we can add as .md files by adding them to dartdoc_options.yaml without specifying them inside the source as well.

cc @jonasfj

@srawlins
Copy link
Member

srawlins commented Mar 6, 2025

Thanks for filing a bug! Is this the same as #1096?

@HosseinYousefi
Copy link
Member Author

It is similar. We could use the same category mechanism as far as I'm concerned in this issue without having to manually add all the categories to the main library for example:

/// {@category foo}
/// {@category bar}
library;

There is a showUndocumentedCategories option but that doesn't do this.

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