Skip to content

Generated documentation should not include elements annotated with @internal #4036

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

Closed
rrousselGit opened this issue Apr 21, 2025 · 1 comment

Comments

@rrousselGit
Copy link

rrousselGit commented Apr 21, 2025

Consider:

class A {
  @internal
  int field = 0;
}

In this scenario, A.field will be visible in Dartdoc's generated website. But that's obviously undesired

We can also add /// @nodocs, but that feels a bit redundant. I think it'd be more logical if a @internal implied /// @nodoc

@bwilkerson bwilkerson transferred this issue from dart-lang/sdk Apr 21, 2025
@sigurdm sigurdm closed this as completed May 12, 2025
@sigurdm
Copy link
Contributor

sigurdm commented May 12, 2025

Duplicate of #2418

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants