Docserver: Display enum value descriptions in API docs.

chrome/common/extensions/docs/server2/api_data_source.py

 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 import copy
 import json
 import logging
 import os
 from collections import defaultdict, Mapping
 
@@ skipping 308 matching lines @@
       dst_dict['choices'] = self._GenerateTypes(type_.choices)
       # We keep track of which == last for knowing when to add "or" between
       # choices in templates.
       if len(dst_dict['choices']) > 0:
         dst_dict['choices'][-1]['last'] = True
     elif type_.property_type == model.PropertyType.REF:
       dst_dict['link'] = self._GetLink(type_.ref_type)
     elif type_.property_type == model.PropertyType.ARRAY:
       dst_dict['array'] = self._GenerateType(type_.item_type)
     elif type_.property_type == model.PropertyType.ENUM:
       dst_dict['enum_values'] = []

[not at google - send to devlin, 2013/10/29 16:25:16]

dst_dict['enum_values'] = [{'name': value.name,
                            'description': value.description}
                           for value in type_.enum_values]

[Sam McNally, 2013/10/30 03:08:37]

Done.

-      for enum_value in type_.enum_values:
-        dst_dict['enum_values'].append({'name': enum_value})
+      for value in type_.enum_values:
+        dst_dict['enum_values'].append(
+          {'name': value.name, 'description': value.description})
       if len(dst_dict['enum_values']) > 0:
         dst_dict['enum_values'][-1]['last'] = True
     elif type_.instance_of is not None:
       dst_dict['simple_type'] = type_.instance_of.lower()
     else:
       dst_dict['simple_type'] = type_.property_type.name.lower()
 
   def _GetIntroTableList(self):
     '''Create a generic data structure that can be traversed by the templates
     to create an API intro table.
@@ skipping 307 matching lines @@
 
     if self._disable_refs:
       cache, ext = (
           (self._idl_cache_no_refs, '.idl') if (unix_name in idl_names) else
           (self._json_cache_no_refs, '.json'))
     else:
       cache, ext = ((self._idl_cache, '.idl') if (unix_name in idl_names) else
                     (self._json_cache, '.json'))
     return self._GenerateHandlebarContext(
         cache.GetFromFile('%s/%s%s' % (self._base_path, unix_name, ext)).Get())