Allow "internal" APIs to be specified in extension API schemas.

chrome/common/extensions/docs/build/directory.py

 #!/usr/bin/python
 # 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.
 
 """Class for parsing metadata about extension samples."""
 
 import locale
 import os
 import os.path
@@ skipping 89 matching lines @@
           methods to parse, and what kind of documentation URL to generate.
 
     Returns:
       A dict of extension methods mapped to file and hash URL parts for the
       corresponding documentation links, like:
         {
           "chrome.tabs.remove": "tabs.html#method-remove",
           "chrome.tabs.onDetached" : "tabs.html#event-onDetatched"
         }
 
-      If the API namespace is defined "nodoc" then an empty dict is returned.
+      If the API namespace is defined "nodoc" or "internal" then an empty dict
+      is returned.
 
     Raises:
       Exception: If the key supplied is not a member of _MODULE_DOC_KEYS.
     """
     methods = []
     api_dict = {}
     namespace = module['namespace']
-    if module.has_key('nodoc'):
+    if self._disableDocs(module):
       return api_dict
     if key not in self._MODULE_DOC_KEYS:
       raise Exception("key %s must be one of %s" % (key, self._MODULE_DOC_KEYS))
     if module.has_key(key):
       methods.extend(module[key])
     for method in methods:
-      if method.has_key('nodoc'):
+      if self._disableDocs(method):
         continue
       method_name = 'chrome.%s.%s' % (namespace, method['name'])
       hashprefix = 'method'
       if key == 'events':
         hashprefix = 'event'
       api_dict[method_name] = self._getDocLink(method_name, hashprefix)
     return api_dict
 
   def getModuleNames(self):
     """ Returns the names of individual modules in the API.
 
     Returns:
       The namespace """
-    # Exclude modules with a "nodoc" property.
+    # Exclude modules with documentation disabled.
     return set(module['namespace'].encode() for module in self._manifest
-               if "nodoc" not in module)
+               if not self._disableDocs(module))
+
+  def _disableDocs(self, obj):
+    for key in ['nodoc', 'internal']:
+      if key in obj and obj[key]:
+        return True
+    return False
 
   def getDocumentationLinks(self):
     """ Parses the extension API JSON manifest and returns a dict of all
     events and methods for every module, mapped to relative documentation links.
 
     Returns:
       A dict of methods/events => partial doc links for every module.
     """
     api_dict = {}
     for module in self._manifest:
@@ skipping 568 matching lines @@
           zip_file.write(abspath, relpath)
           if file == 'manifest.json':
             info = zip_file.getinfo(zip_manifest_path)
             info.comment = self['source_hash']
     except RuntimeError, msg:
       raise Exception("Could not write zip at %s: %s" % (zip_path, msg))
     finally:
       zip_file.close()
 
     return self._get_relative_zip_path()