Merge pull request #1224 from dart-lang/change_constant_display

fix issues with dispaying constants

Author: devoncarew

CHANGELOG.md

@@ -1,4 +1,9 @@
 
+## 0.9.7+1
+* change how we truncate long constant values on the summary page
+* show the full docs for enums on the summary page; just show the first line of
+  docs for other contants
+
 ## 0.9.7
 * fix the display of long constants
 * fixed an issue with duplicate libraries in SDK

lib/dartdoc.dart

@@ -40,7 +40,7 @@ export 'src/package_meta.dart';
 
 const String name = 'dartdoc';
 // Update when pubspec version changes.
-const String version = '0.9.7';
+const String version = '0.9.7+1';
 
 final String defaultOutDir = p.join('doc', 'api');
 

lib/resources/styles.css

@@ -305,14 +305,6 @@ dl dt.callable .name {
   color: #4674a2;
 }
 
-/* make sure constant values don't overflow */
-.signature code {
-  white-space: nowrap;
-  overflow-x: hidden;
-  text-overflow: ellipsis;
-  display: block;
-}
-
 .optional {
   font-style: italic;
 }

lib/src/markdown_processor.dart

@@ -189,7 +189,8 @@ class Documentation {
 
       if (pre.children.isNotEmpty && pre.children.first.localName == 'code') {
         var code = pre.children.first;
-        pre.classes.addAll(code.classes.where((name) => name.startsWith('language-')));
+        pre.classes
+            .addAll(code.classes.where((name) => name.startsWith('language-')));
       }
 
       bool specifiesLanguage = pre.classes.isNotEmpty;
@@ -203,6 +204,9 @@ class Documentation {
     var asOneLiner = asHtmlDocument.body.children.isEmpty
         ? ''
         : asHtmlDocument.body.children.first.innerHtml;
+    if (!asOneLiner.startsWith('<p>')) {
+      asOneLiner = '<p>$asOneLiner</p>';
+    }
     return new Documentation._(markdown, asHtml, asOneLiner);
   }
 }

lib/src/model.dart

@@ -26,7 +26,7 @@ import 'line_number_cache.dart';
 import 'markdown_processor.dart' show Documentation;
 import 'model_utils.dart';
 import 'package_meta.dart' show PackageMeta, FileContents;
-import 'utils.dart' show stripComments;
+import 'utils.dart';
 
 Map<String, Map<String, List<Map<String, dynamic>>>> __crossdartJson;
 
@@ -772,6 +772,9 @@ class EnumField extends Field {
     }
   }
 
+  @override
+  String get oneLineDoc => documentationAsHtml;
+
   @override
   String get href =>
       '${library.dirName}/${(enclosingElement as Class).fileName}';
@@ -809,6 +812,8 @@ class Field extends ModelElement
     return _constantValue;
   }
 
+  String get constantValueTruncated => truncateString(constantValue, 200);
+
   @override
   ModelElement get enclosingElement {
     if (_enclosingClass == null) {
@@ -1531,7 +1536,6 @@ abstract class ModelElement implements Comparable, Nameable, Documentable {
 
   String linkedParams(
       {bool showMetadata: true, bool showNames: true, String separator: ', '}) {
-
     String renderParam(Parameter param, String suffix) {
       StringBuffer buf = new StringBuffer();
       buf.write('<span class="parameter" id="${param.htmlId}">');
@@ -2165,6 +2169,8 @@ class TopLevelVariable extends ModelElement
     return string.replaceAll(modelType.name, modelType.linkedName);
   }
 
+  String get constantValueTruncated => truncateString(constantValue, 200);
+
   @override
   ModelElement get enclosingElement => library;
 

lib/src/utils.dart

@@ -41,3 +41,11 @@ String stripComments(String str) {
   }
   return buf.toString().trim();
 }
+
+String truncateString(String str, int length) {
+  if (str != null && str.length > length) {
+    return str.substring(0, length) + '…';
+  } else {
+    return str;
+  }
+}

lib/templates/_callable.html

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

lib/templates/_constant.html

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

lib/templates/_property.html

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

lib/templates/class.html

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