Skip to content

Commit 5de4ace

Browse files
authored
specify that doc comments are allowed in augmentations (#3048)
1 parent c16cf29 commit 5de4ace

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

working/augmentation-libraries/feature-specification.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Augmentation Libraries
22

33
4-
Version: 1.8 (see [Changelog](#Changelog) at end)
4+
Version: 1.9 (see [Changelog](#Changelog) at end)
55

66
Augmentation libraries allow splitting a Dart library into files. Unlike part
77
files, each augmentation has its [own imports][part imports] and top-level
@@ -894,6 +894,16 @@ To merge a set of declarations `D` into a namespace:
894894
expression, an `augment super` expression invokes the original
895895
variable initializer.
896896

897+
## Documentation comments
898+
899+
Documentation comments are allowed in all the standard places in augmentation
900+
libraries. It is up to the tooling to decide how to present such documentation
901+
comments to the user, but they should generally be considered to be additive,
902+
and should not completely override the original comment. In other words, it is
903+
not the expectation that augmentations should duplicate the original
904+
documentation comments, but instead provide comments that are specific to the
905+
augmentation.
906+
897907
## Deprecating part files
898908

899909
Part files have been [discouraged for many years][discourage]. They are still
@@ -909,6 +919,12 @@ language and our tools.
909919

910920
## Changelog
911921

922+
### 1.9
923+
924+
* Specify that documentation comments are allowed, and should be considered to
925+
be additive and not a complete override of the original comment. The rest of
926+
the behavior is left up to implementations and not specified.
927+
912928
### 1.8
913929

914930
* Specify that main libraries and thier augmentations must have the same

0 commit comments

Comments
 (0)