<appview> documentation.

tools/json_schema_compiler/idl_schema.py

 #! /usr/bin/env 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.
 
 import itertools
 import json
 import os.path
 import re
 import sys
@@ skipping 325 matching lines @@
   dictionary that the JSON schema compiler expects to see.
   '''
 
   def __init__(self,
                namespace_node,
                description,
                nodoc=False,
                internal=False,
                platforms=None,
                compiler_options=None,
-               deprecated=None):
+               deprecated=None,
+               documentation_options=None):
     self.namespace = namespace_node
     self.nodoc = nodoc
     self.internal = internal
     self.platforms = platforms
     self.compiler_options = compiler_options
     self.events = []
     self.functions = []
     self.types = []
     self.callbacks = OrderedDict()
     self.description = description
     self.deprecated = deprecated
+    self.documentation_options = documentation_options
 
   def process(self):
     for node in self.namespace.GetChildren():
       if node.cls == 'Dictionary':
         self.types.append(Dictionary(node).process(self.callbacks))
       elif node.cls == 'Callback':
         k, v = Member(node).process(self.callbacks)
         self.callbacks[k] = v
       elif node.cls == 'Interface' and node.GetName() == 'Functions':
         self.functions = self.process_interface(node)
       elif node.cls == 'Interface' and node.GetName() == 'Events':
         self.events = self.process_interface(node)
       elif node.cls == 'Enum':
         self.types.append(Enum(node).process())
       else:
         sys.exit('Did not process %s %s' % (node.cls, node))
     if self.compiler_options is not None:

[not at google - send to devlin, 2015/03/03 23:50:59]

We should write both of these like:

compiler_options = self.compiler_options or {}
documentation_options = self.documentation_options or {}

[lfg, 2015/03/04 21:13:02]

Done.

       compiler_options = self.compiler_options
     else:
       compiler_options = {}
+    if self.documentation_options is not None:
+      documentation_options = self.documentation_options
+    else:
+      documentation_options = {}
     return {'namespace': self.namespace.GetName(),
             'description': self.description,
             'nodoc': self.nodoc,
             'types': self.types,
             'functions': self.functions,
             'internal': self.internal,
             'events': self.events,
             'platforms': self.platforms,
             'compiler_options': compiler_options,
-            'deprecated': self.deprecated}
+            'deprecated': self.deprecated,
+            'documentation_options': documentation_options}
 
   def process_interface(self, node):
     members = []
     for member in node.GetChildren():
       if member.cls == 'Member':
         _, properties = Member(member).process(self.callbacks)
         members.append(properties)
     return members
 
 
 class IDLSchema(object):
   '''
   Given a list of IDLNodes and IDLAttributes, converts into a Python list
   of api_defs that the JSON schema compiler expects to see.
   '''
 
   def __init__(self, idl):
     self.idl = idl
 
   def process(self):
     namespaces = []
     nodoc = False
     internal = False
     description = None
     platforms = None
     compiler_options = {}
     deprecated = None
+    documentation_options = {}
     for node in self.idl:
       if node.cls == 'Namespace':
         if not description:
           # TODO(kalman): Go back to throwing an error here.
           print('%s must have a namespace-level comment. This will '
                            'appear on the API summary page.' % node.GetName())
           description = ''
         namespace = Namespace(node, description, nodoc, internal,
                               platforms=platforms,
                               compiler_options=compiler_options or None,
-                              deprecated=deprecated)
+                              deprecated=deprecated,
+                              documentation_options=documentation_options)
         namespaces.append(namespace.process())
         nodoc = False
         internal = False
         platforms = None
         compiler_options = None
       elif node.cls == 'Copyright':
         continue
       elif node.cls == 'Comment':
         description = node.GetName()
       elif node.cls == 'ExtAttribute':
         if node.name == 'nodoc':
           nodoc = bool(node.value)
         elif node.name == 'internal':
           internal = bool(node.value)
         elif node.name == 'platforms':
           platforms = list(node.value)
         elif node.name == 'implemented_in':
           compiler_options['implemented_in'] = node.value
         elif node.name == 'camel_case_enum_to_string':
           compiler_options['camel_case_enum_to_string'] = node.value
         elif node.name == 'deprecated':
           deprecated = str(node.value)
+        elif node.name == 'documentation_options_title':
+          documentation_options['title'] = node.value
+        elif node.name == 'documentation_options_namespace':
+          documentation_options['namespace'] = node.value
+        elif node.name == 'documentation_options_documented_in':
+          documentation_options['documented_in'] = node.value

[not at google - send to devlin, 2015/03/03 23:50:59]

Let's make this a little less wordy:
documentation_options_title --> documentation_title
documentation_options_namespace --> documentation_namespace
documentation_options_documented_in --> documented_in

[lfg, 2015/03/04 21:13:02]

Done.

         else:
           continue
       else:
         sys.exit('Did not process %s %s' % (node.cls, node))
     return namespaces
 
 
 def Load(filename):
   '''
   Given the filename of an IDL file, parses it and returns an equivalent
@@ skipping 20 matching lines @@
       print json.dumps(schema, indent=2)
   else:
     contents = sys.stdin.read()
     idl = idl_parser.IDLParser().ParseData(contents, '<stdin>')
     schema = IDLSchema(idl).process()
     print json.dumps(schema, indent=2)
 
 
 if __name__ == '__main__':
   Main()