Repository navigation
Add a hideConstantImplementations dartdoc directive - #3398
Merged
Merged
Conversation
srawlins
reviewed
Apr 26, 2023
| ```dart | ||
| /// This is truly an amazing library. | ||
| /// {@hideConstantImplementations} | ||
| library my_library; |
Member
There was a problem hiding this comment.
nit: I think we're steering away from named libraries like this; we can use library; in Dart 2.19.
|
|
||
| final _canonicalRegExp = RegExp(r'{@canonicalFor\s([^}]+)}'); | ||
|
|
||
| /// Used by [Library] to implement the canonicalFor directive. |
Member
There was a problem hiding this comment.
Can we wrap 'canonicalFor' in some delimiter like backticks?
| /// Mixin implementing dartdoc categorization for ModelElements. | ||
| mixin Categorization implements ModelElement { | ||
| /// Mixin parsing the `@category` directive for ModelElements. | ||
| mixin Categorization on DocumentationComment implements Indexable { |
|
|
||
| /// [true] if the {@hideConstantImplementations} dartdoc directive is present | ||
| /// in the documentation for this class. | ||
| bool get hideConstantImplementations { |
Member
There was a problem hiding this comment.
The name here makes it sound like a function, like calling hideConstantImplementations will do something or set something. What about hasHideConstantImplementations, like how the analyzer APIs are named?
| return _hideConstantImplementations!; | ||
| } | ||
|
|
||
| /// Hides [hideConstantImplementations] from doc while leaving a note to |
Member
There was a problem hiding this comment.
Hmm, is this reference right? This function doesn't hide the bool getter, hideConstantImplementations. Maybe "Hides {@hideConstantImplementations} ..."?
|
|
||
| /// True if the @hideConstantImplementations directive is present | ||
| /// in the defining enclosing element. | ||
| bool get hideConstantImplementation; |
Member
There was a problem hiding this comment.
Same naming for here, maybe hasHide... or shouldHide...?
srawlins
approved these changes
May 3, 2023
Contributor
Author
|
The grind.dart changes are due to some yaks that needed shaving: the name |
Merged
8 tasks done
auto-submit Bot
pushed a commit
to flutter/flutter
that referenced
this pull request
Jun 8, 2023
…c pages (#128442) This updates dartdoc to 6.3.0. Release notes are available, here: https://github.com/dart-lang/dartdoc/releases/tag/v6.3.0 Most important for Flutter are the reduction in the size of generated HTML files (dart-lang/dartdoc#3384) and a new dartdoc directive to hide constant implementations from indicated classes (dart-lang/dartdoc#3398), which fixes the longstanding issue (dart-lang/dartdoc#2657). I've also added the api documentation zip to `.gitignore` and the `{@hideConstantImplementations}` dartdoc directive to the motivating example. A screenshot:  I assert that this change to icons.dart should be test-exempt as existing tests cover whether or not dartdoc directives are recognized or are leaking into HTML, and the impact of adding the directive was tested in dart-lang/dartdoc#3398.
copybara-service Bot
pushed a commit
to dart-lang/sdk
that referenced
this pull request
Sep 27, 2023
Directive introduced in dart-lang/dartdoc#3398 but not documented yet. Still experimental, but used by Flutter. Change-Id: I277927a54caf926b0b3d13db589486465ab9358d Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/328180 Commit-Queue: Samuel Rawlins <[email protected]> Reviewed-by: Phil Quitslund <[email protected]>
chunhtai
pushed a commit
to chunhtai/packages
that referenced
this pull request
Jun 12, 2026
…c pages (#128442) This updates dartdoc to 6.3.0. Release notes are available, here: https://github.com/dart-lang/dartdoc/releases/tag/v6.3.0 Most important for Flutter are the reduction in the size of generated HTML files (dart-lang/dartdoc#3384) and a new dartdoc directive to hide constant implementations from indicated classes (dart-lang/dartdoc#3398), which fixes the longstanding issue (dart-lang/dartdoc#2657). I've also added the api documentation zip to `.gitignore` and the `{@hideConstantImplementations}` dartdoc directive to the motivating example. A screenshot:  I assert that this change to icons.dart should be test-exempt as existing tests cover whether or not dartdoc directives are recognized or are leaking into HTML, and the impact of adding the directive was tested in dart-lang/dartdoc#3398.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #2657.
Without trying to solve #3397 this PR does also move a few things around to make it more clear where the various directives are currently implemented as adding yet another one via
buildDocumentationAdditionwas starting to look messy.Here is a sample screenshot of what
Iconswould look like with the new directive: