update dartdoc for the generatedByComment field

dart-archive · Dec 12, 2023 · c6b71bc · c6b71bc
1 parent a531aad
commit c6b71bc
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/lib/src/specs/library.dart b/lib/src/specs/library.dart
@@ -31,6 +31,9 @@ abstract class Library
   BuiltList<String> get comments;
 
   /// A comment indicating the tool this library was generated by.
+  ///
+  /// This is typically of the form `Generated by xxx.` (and should exclude
+  /// leading line comment characters).
   String? get generatedByComment;
 
   /// A list of analysis issues to ignore (`ignore_for_file: ...`).