js-client-gen: Add optional class name for improved JSDocs.

braincore · braincore · commit 62526c782fe2 · 2016-06-06T14:29:47.000-07:00
diff --git a/stone/target/js_client.py b/stone/target/js_client.py
@@ -20,13 +20,17 @@
     help=('The name to give the single Javascript file that is created and '
           'contains all of the routes.'),
 )
+_cmdline_parser.add_argument(
+    '-c',
+    '--class-name',
+    type=str,
+    help=('The name of the class the generated functions will be attached to. '
+          'The name will be added to each function documentation, which makes '
+          'it available for tools like JSDoc.'),
+)
 
 _header = """\
 // Auto-generated by Stone, do not modify.
-/**
- * @class Routes
- * @classdesc Contains a corresponding method for each route.
- */
 var routes = {};
 """
 
@@ -59,7 +63,9 @@ def _generate_route(self, route_schema, namespace, route):
         self.emit('/**')
         if route.doc:
             self.emit_wrapped_text(self.process_doc(route.doc, self._docf), prefix=' * ')
-        self.emit(' * @function Routes#%s' % function_name)
+        if self.args.class_name:
+            self.emit(' * @function {}#{}'.format(self.args.class_name,
+                                                  function_name))
         if route.deprecated:
             self.emit(' * @deprecated')
 
