Generate documentation for enumeration values.

pkg/analyzer/tool/summary/generate.dart

 // Copyright (c) 2015, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 /**
  * This file contains code to generate serialization/deserialization logic for
  * summaries based on an "IDL" description of the summary format (written in
  * stylized Dart).
  *
  * For each class in the "IDL" input, two corresponding classes are generated:
@@ skipping 107 matching lines @@
   }
 
   /**
    * Generate a Dart expression representing the default value for a field
    * having the given [type], or `null` if there is no default value.
    */
   String defaultValue(idlModel.FieldType type) {
     if (type.isList) {
       return 'const <${type.typeName}>[]';
     } else if (_idl.enums.containsKey(type.typeName)) {
-      return '${type.typeName}.${_idl.enums[type.typeName].values[0]}';
+      return '${type.typeName}.${_idl.enums[type.typeName].values[0].name}';
     } else if (type.typeName == 'int') {
       return '0';
     } else if (type.typeName == 'String') {
       return "''";
     } else if (type.typeName == 'bool') {
       return 'false';
     } else {
       return null;
     }
   }
@@ skipping 58 matching lines @@
           } else {
             throw new Exception('Unexpected class member `$classMember`');
           }
         }
       } else if (decl is EnumDeclaration) {
         String doc = _getNodeDoc(lineInfo, decl);
         idlModel.EnumDeclaration enm =
             new idlModel.EnumDeclaration(doc, decl.name.name);
         _idl.enums[enm.name] = enm;
         for (EnumConstantDeclaration constDecl in decl.constants) {
-          enm.values.add(constDecl.name.name);
+          String doc = _getNodeDoc(lineInfo, constDecl);
+          enm.values
+              .add(new idlModel.EnumValueDeclaration(doc, constDecl.name.name));
         }
       } else if (decl is TopLevelVariableDeclaration) {
         // Ignore top level variable declarations; they are present just to make
         // the IDL analyze without warnings.
       } else {
         throw new Exception('Unexpected declaration `$decl`');
       }
     }
   }
 
@@ skipping 165 matching lines @@
             condition = ' || $valueName.isEmpty';
             if (_idl.classes.containsKey(fieldType.typeName)) {
               String itemCode = 'b.finish(fbBuilder)';
               String listCode = '$valueName.map((b) => $itemCode).toList()';
               writeCode = '$offsetName = fbBuilder.writeList($listCode);';
             } else if (_idl.enums.containsKey(fieldType.typeName)) {
               String itemCode = 'b.index';
               String listCode = '$valueName.map((b) => $itemCode).toList()';
               writeCode = '$offsetName = fbBuilder.writeListUint32($listCode);';
             } else if (fieldType.typeName == 'int') {
-              writeCode = '$offsetName = fbBuilder.writeListUint32($valueName);';
+              writeCode =
+                  '$offsetName = fbBuilder.writeListUint32($valueName);';
             } else if (fieldType.typeName == 'double') {
-              writeCode = '$offsetName = fbBuilder.writeListFloat64($valueName);';
+              writeCode =
+                  '$offsetName = fbBuilder.writeListFloat64($valueName);';
             } else {
               assert(fieldType.typeName == 'String');
               String itemCode = 'fbBuilder.writeString(b)';
               String listCode = '$valueName.map((b) => $itemCode).toList()';
               writeCode = '$offsetName = fbBuilder.writeList($listCode);';
             }
           } else if (fieldType.typeName == 'String') {
             writeCode = '$offsetName = fbBuilder.writeString($valueName);';
           } else if (_idl.classes.containsKey(fieldType.typeName)) {
             writeCode = '$offsetName = $valueName.finish(fbBuilder);';
@@ skipping 47 matching lines @@
       out('}');
     });
     out('}');
   }
 
   void _generateEnum(idlModel.EnumDeclaration enm) {
     String name = enm.name;
     outDoc(enm.documentation);
     out('enum $name {');
     indent(() {
-      for (String value in enm.values) {
-        out('$value,');
+      for (idlModel.EnumValueDeclaration value in enm.values) {
+        outDoc(value.documentation);
+        if (enm.values.last == value) {
+          out('${value.name}');
+        } else {
+          out('${value.name},');
+          out();
+        }
       }
     });
     out('}');
   }
 
   void _generateEnumReader(idlModel.EnumDeclaration enm) {
     String name = enm.name;
     String readerName = '_${name}Reader';
     out('class $readerName extends fb.Reader<$name> {');
     indent(() {
@@ skipping 155 matching lines @@
       return token.lexeme.split('\n').map((String line) {
         if (line.startsWith(indent)) {
           line = line.substring(indent.length);
         }
         return line;
       }).join('\n');
     }
     return null;
   }
 }