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

Specified categories were disapperared from the API doc #3953

Open
AlexV525 opened this issue Dec 25, 2024 · 6 comments
Open

Specified categories were disapperared from the API doc #3953

AlexV525 opened this issue Dec 25, 2024 · 6 comments
Labels
P2 A bug or feature request we're likely to work on

Comments

@AlexV525
Copy link

The request cfug/dio#2344 is trying to remove the categories doc annotation, but then the topics disappeared.

However, the doc of the package pxl.dart seems working well while we have a similar configuration.

@srawlins
Copy link
Member

Please elaborate on what problem you are seeing. What did you try to do? What was the expected result? What was the actual result?

@AlexV525
Copy link
Author

https://pub.dev/documentation/dio/latest/dio/

There are two topics in the doc. The pull request is about removing the category annotation: https://github.com/cfug/dio/blob/b16a611a14b8b8a4cb7f2556628a5f030c315ffd/dio/lib/dio.dart#L4-L5

After removed, those topics are disappeared from the doc: cfug/dio#2344 (comment)

We have configured categories in the yaml: https://github.com/cfug/dio/blob/main/dio/dartdoc_options.yaml

I looked at the package pxl.dart and it doesn't seem to have extra configuration but topics are displayed correctly in its doc.

@AlexV525
Copy link
Author

Hi @srawlins , sorry for the previous lack of detailed comment. Is this something we can move on now?

@srawlins
Copy link
Member

Yes, that should be enough to start an investigation.

@pq pq added the P2 A bug or feature request we're likely to work on label Jan 29, 2025
@jonasfj
Copy link
Member

jonasfj commented Apr 9, 2025

I suspect showUndocumentedCategories: true just causes categories for which no markdown file exists to be included in the list of categories.

I don't think there is an option to include categories that are not referenced with {@Category ...} -- I suppose that maybe that's what showUndocumentedCategories should do -- or maybe we should have an showUnusedCategories option.

@jonasfj
Copy link
Member

jonasfj commented Apr 9, 2025

See also #4012, which is probably the same use case.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P2 A bug or feature request we're likely to work on
Projects
None yet
Development

No branches or pull requests

4 participants