Extensions Docs Server: Show parameters of functions that are properties of an object

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 os
 
 from docs_server_utils import GetLinkToRefType
 import compiled_file_system as compiled_fs
 from file_system import FileNotFoundError
 import third_party.json_schema_compiler.json_comment_eater as json_comment_eater
 import third_party.json_schema_compiler.model as model
 import third_party.json_schema_compiler.idl_schema as idl_schema
 import third_party.json_schema_compiler.idl_parser as idl_parser
 
 # Increment this version when there are changes to the data stored in any of
 # the caches used by APIDataSource. This allows the cache to be invalidated
 # without having to flush memcache on the production server.
-_VERSION = 0
+_VERSION = 1

[Aaron Boodman, 2012/10/24 22:29:24]

Note that this conflicts with: http://codereview.chromium.org/11195055/

[cduvall, 2012/10/25 23:42:02]

Yeah, this number only needs to change once per server upload, so it doesn't
really matter what it is, as long as its different from the current production
server.

 
 def _RemoveNoDocs(item):
   if type(item) == dict:
     if item.get('nodoc', False):
       return True
     for key, value in item.items():
       if _RemoveNoDocs(value):
         del item[key]
   elif type(item) == list:
     for i in item:
@@ skipping 142 matching lines @@
   def _GenerateProperties(self, properties):
     return [self._GenerateProperty(v) for v in properties.values()
             if v.type_ != model.PropertyType.ADDITIONAL_PROPERTIES]
 
   def _GenerateProperty(self, property_):
     property_dict = {
       'name': property_.simple_name,
       'optional': property_.optional,
       'description': self._FormatDescription(property_.description),
       'properties': self._GenerateProperties(property_.properties),
+      'parameters': [],
       'functions': self._GenerateFunctions(property_.functions),
       'id': _CreateId(property_, 'property')
     }
+    for param in property_.params:
+      property_dict['parameters'].append(self._GenerateProperty(param))
     if (property_.parent is not None and
         not isinstance(property_.parent, model.Namespace)):
       property_dict['parent_name'] = property_.parent.simple_name
     else:
       property_dict['parent_name'] = None
     if property_.has_value:
       if isinstance(property_.value, int):
         property_dict['value'] = _FormatValue(property_.value)
       else:
         property_dict['value'] = property_.value
@@ skipping 126 matching lines @@
 
   def get(self, key):
     path, ext = os.path.splitext(key)
     unix_name = model.UnixName(path)
     idl_names = self._idl_names_cache.GetFromFileListing(self._base_path)
     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)),
         path)