Skip to content

Always apply @hideConstantImplementations directive. #3564

Closed
@srawlins

Description

@srawlins

We were planning a gradual / opt-in view of constants where the implementation (source code) could be hidden, if you annotated a library (or class?) with /// {@hideConstantImplementations}. But I think we're moving with high certainty to a UX where all implementations are hidden.

Also, re-implementing support for this directive, when it will become useless soon, is not a good plan.

One path going forward then, a very easy change to the code, is for dartdoc to act as though all constants are annotated like this, and their implementations should be hidden.

The only uses of this doc directive that I know of are at https://github.com/flutter/flutter/blob/master/packages/flutter/lib/src/cupertino/icons.dart and https://github.com/flutter/flutter/blob/master/packages/flutter/lib/src/material/icons.dart. It's super new, so should be easy to drop.

We can just drop hide_constant_implementations.dart and replace all references to hasHideConstantImplementations (and hasHideConstantImplementation) with true. (So GetterSetterCombo.hasConstantValueForDisplay becomes always false, etc.

Metadata

Metadata

Assignees

Labels

type-tech-debtIssues that slow or block desirable development paths for Dartdoc, or create such problems for users

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions