Issue 2271 - Enable documentation for Chrome extensions

build.py

Index: build.py
===================================================================
--- a/build.py
+++ b/build.py
@@ -369,10 +369,14 @@
     return
   targetDir = args[0]
 
-  command = ['jsdoc',
-             '--destination', targetDir,
-             '--access', 'all',
-             os.path.join(baseDir, 'lib')]
+  source_dir = os.path.join(baseDir, 'lib')
+  sources = [source_dir]
+
+  # JSDoc struggles wih huge objects: https://github.com/jsdoc3/jsdoc/issues/976

[kzar, 2015/04/05 12:51:41]

Maybe instead of this logic we could use a JSdoc configuration file with an
exclude pattern? http://usejsdoc.org/about-configuring-jsdoc.html

[Sebastian Noack, 2015/04/05 13:08:56]

This would be kinda nice, because the JSDoc configuration could be done in the
repective repo then, and the logic in buildtools could be agnostic of the source
files.

But on the other hand this hack will (hopefully) be just temporarily. And the
logic is simpler without delegating to a config file.

[kzar, 2015/04/05 13:30:51]

Wouldn't the logic be pretty simple if we use a config file though? I thought we
could just add an extra argument to the command array to specify the config
path, and then just use the configuration for special things like excluding
publicSuffixList.js. Otherwise avoiding changes to this chunk of code.

[Sebastian Noack, 2015/04/05 13:34:33]

The logic here would be reasonable. But the actual logic is just delegated to
the configfile. And spreading logic isn't great, unless there is a reason for
it.

[kzar, 2015/04/05 15:12:55]

Fair enough I suppose.

+  if type == 'chrome':
+    sources = [os.path.join(source_dir, filename) for filename in os.listdir(source_dir) if filename != 'publicSuffixList.js']
+
+  command = ['jsdoc', '--destination', targetDir, '--access', 'all'] + sources
   if any(opt in ('-q', '--quiet') for opt, _ in opts):
     process = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
     stderr = process.communicate()[1]
@@ -483,7 +487,7 @@
   command.description = 'Generate documentation files and write them into the specified directory. This operation requires JsDoc 3 to be installed.'
   command.addOption('Suppress JsDoc output', short='q', long='quiet')
   command.params = '[options] <directory>'
-  command.supportedTypes = ('gecko')
+  command.supportedTypes = ('gecko', 'chrome')
 
 with addCommand(runReleaseAutomation, 'release') as command:
   command.shortDescription = 'Run release automation'