Merge pull request #1181 from dart-lang/show_entire_first_line_text

show the entire text for the first line of dartdoc

Author: devoncarew

lib/resources/styles.css

@@ -255,7 +255,6 @@ dd.callable, dd.constant, dd.property {
 }
 
 dd p {
-  white-space: nowrap;
   overflow-x: hidden;
   text-overflow: ellipsis;
   margin-bottom: 0;

lib/src/html/templates.dart

@@ -10,8 +10,6 @@ import 'resource_loader.dart' as loader;
 typedef String TemplateRenderer(context,
     {bool assumeNullNonExistingProperty, bool errorOnMissingProperty});
 
-// TODO: if we can ever enumerate the contents of a package, we
-// won't need this.
 const _partials = const <String>[
   'callable',
   'callable_multiline',
@@ -26,7 +24,6 @@ const _partials = const <String>[
   'sidebar_for_class',
   'source_code',
   'sidebar_for_library',
-  'has_more_docs',
   'accessor_getter',
   'accessor_setter'
 ];

lib/src/markdown_processor.dart

@@ -163,7 +163,6 @@ class Documentation {
   final String raw;
   final String asHtml;
   final String asOneLiner;
-  final bool hasMoreThanOneLineDocs;
 
   factory Documentation(String markdown) {
     String tempHtml = _renderMarkdownToHtml(markdown);
@@ -175,8 +174,7 @@ class Documentation {
     return new Documentation._internal(element.documentation, tempHtml);
   }
 
-  Documentation._(
-      this.raw, this.asHtml, this.hasMoreThanOneLineDocs, this.asOneLiner);
+  Documentation._(this.raw, this.asHtml, this.asOneLiner);
 
   factory Documentation._internal(String markdown, String rawHtml) {
     var asHtmlDocument = parse(rawHtml);
@@ -206,18 +204,14 @@ class Documentation {
     }
     var asHtml = asHtmlDocument.body.innerHtml;
 
-    // Fixes issue with line ending differences between mac and windows, affecting tests
+    // Fixes issue with line ending differences between mac and windows.
     if (asHtml != null) asHtml = asHtml.trim();
 
-    var asOneLiner = '';
-    var moreThanOneLineDoc = asHtmlDocument.body.children.length > 1;
+    var asOneLiner = asHtmlDocument.body.children.isEmpty
+        ? ''
+        : asHtmlDocument.body.children.first.innerHtml;
 
-    if (asHtmlDocument.body.children.isNotEmpty) {
-      asOneLiner = asHtmlDocument.body.children.first.innerHtml;
-    }
-
-    return new Documentation._(
-        markdown, asHtml, moreThanOneLineDoc, asOneLiner);
+    return new Documentation._(markdown, asHtml, asOneLiner);
   }
 }
 

lib/src/model.dart

@@ -659,7 +659,6 @@ abstract class Documentable {
   String get documentation;
   String get documentationAsHtml;
   bool get hasDocumentation;
-  bool get hasMoreThanOneLineDocs;
   String get oneLineDoc;
 }
 
@@ -1364,9 +1363,6 @@ abstract class ModelElement implements Comparable, Nameable, Documentable {
   bool get hasDocumentation =>
       documentation != null && documentation.isNotEmpty;
 
-  @override
-  bool get hasMoreThanOneLineDocs => _documentation.hasMoreThanOneLineDocs;
-
   bool get hasParameters => parameters.isNotEmpty;
 
   String get href;
@@ -1789,8 +1785,6 @@ class Package implements Nameable, Documentable {
   // plain text or markdown.
   bool get hasDocumentationFile => documentationFile != null;
 
-  bool get hasMoreThanOneLineDocs => true;
-
   // TODO: make this work
   String get href => 'index.html';
 

lib/templates/_callable.html

@@ -4,7 +4,7 @@
   </span>
 </dt>
 <dd{{ #isInherited }} class="inherited"{{ /isInherited}}>
-  <p>{{{ oneLineDoc }}}{{>has_more_docs}}</p>
+  <p>{{{ oneLineDoc }}}</p>
   {{#isInherited}}
   <div class="features">inherited</div>
   {{/isInherited}}

lib/templates/_constant.html

@@ -3,7 +3,7 @@
   <span class="signature">&#8594; {{{ linkedReturnType }}}</span>
 </dt>
 <dd>
-  <p>{{{ oneLineDoc }}}{{>has_more_docs}}</p>
+  <p>{{{ oneLineDoc }}}</p>
   <div>
     <span class="signature"><code>{{{ constantValue }}}</code></span>
   </div>

lib/templates/_has_more_docs.html

@@ -3,6 +3,6 @@
   <span class="signature">&#8594; {{{ linkedReturnType }}}</span>
 </dt>
 <dd{{ #isInherited }} class="inherited"{{ /isInherited}}>
-  <p>{{{ oneLineDoc }}}{{>has_more_docs}}</p>
+  <p>{{{ oneLineDoc }}}</p>
   {{>readable_writable}}
 </dd>

lib/templates/_property.html

@@ -114,7 +114,7 @@ <h2>Constructors</h2>
           <span class="name">{{{linkedName}}}</span><span class="signature">({{{ linkedParams }}})</span>
         </dt>
         <dd>
-          <p>{{{ oneLineDoc }}}{{>has_more_docs}}</p>
+          <p>{{{ oneLineDoc }}}</p>
           {{#isConst}}
           <div class="constructor-modifier features">const</div>
           {{/isConst}}

lib/templates/class.html

@@ -91,7 +91,7 @@ <h2>Enums</h2>
           {{{linkedName}}}
         </dt>
         <dd>
-          <p>{{{ oneLineDoc }}}{{>has_more_docs}}</p>
+          <p>{{{ oneLineDoc }}}</p>
         </dd>
         {{/library.enums}}
       </dl>
@@ -108,7 +108,7 @@ <h2>Classes</h2>
           <span class="name {{#isDeprecated}}deprecated{{/isDeprecated}}">{{{linkedName}}}</span>
         </dt>
         <dd>
-          <p>{{{ oneLineDoc }}}{{>has_more_docs}}</p>
+          <p>{{{ oneLineDoc }}}</p>
         </dd>
         {{/library.classes}}
       </dl>
@@ -125,7 +125,7 @@ <h2>Exceptions / Errors</h2>
           <span class="name {{#isDeprecated}}deprecated{{/isDeprecated}}">{{{linkedName}}}</span>
         </dt>
         <dd>
-          <p>{{{ oneLineDoc }}}{{>has_more_docs}}</p>
+          <p>{{{ oneLineDoc }}}</p>
         </dd>
         {{/library.exceptions}}
       </dl>

lib/templates/library.html

@@ -165,11 +165,6 @@ void main() {
               'WOW FAKE PACKAGE IS <strong>BEST</strong> <a href="http://example.org">PACKAGE</a>'));
     });
 
-    test('has more than one line docs (or not)', () {
-      expect(fakeLibrary.hasMoreThanOneLineDocs, true);
-      expect(exLibrary.hasMoreThanOneLineDocs, false);
-    });
-
     test('has properties', () {
       expect(exLibrary.hasProperties, isTrue);
     });