Skip to content

Documentation for properties is painfully verbose #1509

Closed
@jacob314

Description

@jacob314

Documentation for properties is painfully verbose
As Dart already allows fields and properties to be used interchangeably in interfaces and classes, we should always represent properties as fields where practical in the DartDoc. This issue is high priority because documentation for all properties is shown twice for all properties with documentation from MDN making the docs much harder to read.

For example:

http://api.dartlang.org/html/Element.html

String get contentEditable()
Gets/sets whether or not the element is editable.
from MDN

void set contentEditable(String value)
Gets/sets whether or not the element is editable.
from MDN

The documentation should instead read:

String contentEditable
Gets/sets whether or not the element is editable.
from MDN

For read only fields the documentation should read:

final String tagName;
The name of the tag for the given element.

Instead of
String get tagName()
The name of the tag for the given element.

For the very rare cases where getters and setters have different types we can fall back to the existing documentation style.
If the getter and setter have different documentation (never occurs for HTML) we can either display the documentation for the getter followed by the setter in the same block or fall back to the existing style of listing the getter and setter separately.

Metadata

Metadata

Assignees

Labels

P1A high priority bug; for example, a single project is unusable or has many test failures

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions