dart-lang/dartdoc

Specified categories were disapperared from the API doc

AlexV525 opened this issue · 4 comments

AlexV525 commented

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 commented

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 commented

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 commented

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

srawlins commented

Yes, that should be enough to start an investigation.

  • 👍1