Skip to content

dartdoc directive handling is internally inconsistent and inefficient #3397

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.

Sign up for GitHub

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

Jump to bottom
Open
jcollins-g opened this issue Apr 25, 2023 · 0 comments
Open

dartdoc directive handling is internally inconsistent and inefficient #3397

jcollins-g opened this issue Apr 25, 2023 · 0 comments
Labels
P2 A bug or feature request we're likely to work on type-tech-debt Issues that slow or block desirable development paths for Dartdoc, or create such problems for users

Comments

@jcollins-g
Copy link
Contributor

Some dartdoc directives are implemented via an ad-hoc plugin system with buildDocumentationAddition, others are implemented directly as part of DocumentationComment, and the whole thing kind of comes together a bit awkwardly.

Redesign this so that each directive implementation is split out into its own class, and DocumentationComment can have different directives registered as valid on different symbol types (Class, Library, etc).
@jcollins-g jcollins-g added P2 A bug or feature request we're likely to work on type-tech-debt Issues that slow or block desirable development paths for Dartdoc, or create such problems for users labels Apr 25, 2023
@jcollins-g jcollins-g mentioned this issue Apr 25, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
P2 A bug or feature request we're likely to work on type-tech-debt Issues that slow or block desirable development paths for Dartdoc, or create such problems for users
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jcollins-g