Skip to content

Don't document @internal members #2418

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
nex3 opened this issue Nov 4, 2020 · 1 comment
Open

Don't document @internal members #2418

nex3 opened this issue Nov 4, 2020 · 1 comment
Labels
P2 A bug or feature request we're likely to work on type-bug Incorrect behavior (everything from a crash to more subtle misbehavior)

Comments

@nex3
Copy link
Member

nex3 commented Nov 4, 2020

dart-lang/sdk#28066 added support for an @internal annotation, which can be used to mark members as private to the package that defines them. Because these aren't part of a package's public API, DartDoc shouldn't generate documentation for them.
@srawlins
Copy link
Member

srawlins commented Nov 4, 2020

Similar to #1664. I think dartdoc should not generate docs for these.

If we get feedback that some users want docs for these, we can add a flag, but I don't see a strong case for it now.

@nex3 nex3 mentioned this issue Nov 4, 2020
Open
nex3 added a commit to sass/dart-sass that referenced this issue Nov 5, 2020
@nex3
Use @internal to cordon off internal-only Value APIs
d007111 
This is a proof-of-concept for #236. Note that we need to add a bunch
of explicit @Nodoc annotations to work around dart-lang/dartdoc#2418
and dart-lang/dartdoc#2419.
@jcollins-g jcollins-g added type-bug Incorrect behavior (everything from a crash to more subtle misbehavior) P2 A bug or feature request we're likely to work on labels Nov 5, 2020
nex3 added a commit to sass/dart-sass that referenced this issue Jun 24, 2021
@nex3
Use @internal to cordon off internal-only Value APIs
2395c5a 
Lays the groundwork for #236

Note that we need to add a bunch of explicit @Nodoc annotations to
work around dart-lang/dartdoc#2418 and dart-lang/dartdoc#2419.
@nex3 nex3 mentioned this issue Jun 24, 2021
Merged
nex3 added a commit to sass/dart-sass that referenced this issue Jun 25, 2021
@nex3
Use @internal to cordon off internal-only Value APIs (#1379)
a10d7c6 
Lays the groundwork for #236

Note that we need to add a bunch of explicit @Nodoc annotations to
work around dart-lang/dartdoc#2418 and dart-lang/dartdoc#2419.
@sigurdm sigurdm marked this as a duplicate of #4036 May 12, 2025
This was referenced May 12, 2025
Closed
Open
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-bug Incorrect behavior (everything from a crash to more subtle misbehavior)
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@nex3 @srawlins @jcollins-g