Merge pull request #696 from dart-lang/combo-field

put docs for getters and setters together

Author: sethladd

.analysis_options

@@ -2,5 +2,6 @@
 
 analyzer:
   exclude:
+    - test_package/doc/api
     - test_package_bad/
     - doc/api/

lib/src/model.dart

@@ -1161,12 +1161,21 @@ class Field extends ModelElement {
 
   @override
   String get _computeDocumentationComment {
+    var buffer = new StringBuffer();
     if (hasGetter) {
-      return _field.getter.computeDocumentationComment();
-    } else if (hasSetter) {
-      return _field.setter.computeDocumentationComment();
+      buffer.write(_field.getter.computeDocumentationComment());
+    }
+
+    if (hasSetter) {
+      if (buffer.isNotEmpty) buffer.write('\n\n');
+      buffer.write(_field.setter.computeDocumentationComment());
+    }
+
+    if (buffer.isEmpty) {
+      buffer.write(_field.computeDocumentationComment());
+    } else {
+      return buffer.toString();
     }
-    return _field.computeDocumentationComment();
   }
 
   void _setModelType() {

lib/templates/_documentation.html

@@ -1,4 +1,3 @@
-
 <section class="desc markdown">
 
     {{^hasDocumentation}}

test/model_test.dart

@@ -469,7 +469,9 @@ void main() {
   });
 
   group('Field', () {
-    var c, f1, f2, constField, dynamicGetter, onlySetter, LongFirstLine;
+    Class c, LongFirstLine;
+    Field f1, f2, constField, dynamicGetter, onlySetter;
+    Field lengthX;
 
     setUp(() {
       c = exLibrary.classes.firstWhere((c) => c.name == 'Apple');
@@ -482,6 +484,10 @@ void main() {
           .firstWhere((p) => p.name == 'dynamicGetter');
       onlySetter = LongFirstLine.instanceProperties
           .firstWhere((p) => p.name == 'onlySetter');
+
+      lengthX = fakeLibrary.classes.firstWhere(
+              (c) => c.name == 'WithGetterAndSetter').allInstanceProperties
+          .firstWhere((c) => c.name == 'lengthX');
     });
 
     test('is not const', () {
@@ -509,6 +515,11 @@ void main() {
       expect(onlySetter.documentation,
           equals('Only a setter, with a single param, of type double.'));
     });
+
+    test('explicit getter and setter docs are unified', () {
+      expect(lengthX.documentation, contains('Sets the length.'));
+      expect(lengthX.documentation, contains('Returns a length.'));
+    });
   });
 
   group('Variable', () {

test_package/lib/fake.dart

@@ -334,10 +334,10 @@ class WithGetterAndSetter {
   /// Returns a length.
   ///
   /// Throws some exception if used in the fourth dimension.
-  int get length => 1;
+  int get lengthX => 1;
 
   /// Sets the length.
   ///
   /// Throws if set to an imaginary number.
-  void set length(int _length) {}
+  void set lengthX(int _length) {}
 }