docs: update script parser for error-reporting (googleapis#2181)

* docs: update script parser for error-reporting * add error reporting files to ignore list
imathews · Apr 4, 2017 · d765148 · d765148
1 parent f8cdefe
commit d765148
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 2 deletions.
diff --git a/scripts/docs/builder.js b/scripts/docs/builder.js
@@ -81,7 +81,7 @@ Builder.prototype.build = function() {
     ignore: config.IGNORE
   }).map(function(file) {
     var json = self.parseFile(file);
-    var outputFile = file.replace(/^.+src\//, '') + 'on';
+    var outputFile = path.basename(file) + 'on';
 
     json.path = path.basename(outputFile);
     self.write(outputFile, json);

diff --git a/scripts/docs/config.js b/scripts/docs/config.js
@@ -27,6 +27,9 @@ module.exports = {
     'bigtable/src/mutation.js',
     'datastore/src/entity.js',
     'datastore/src/request.js',
+    'error-reporting/src/configuration.js',
+    'error-reporting/src/error-router.js',
+    'error-reporting/src/logger.js',
     'logging/src/metadata.js',
     'pubsub/src/iam.js',
     'spanner/src/codec.js',

diff --git a/scripts/docs/parser.js b/scripts/docs/parser.js
@@ -36,6 +36,11 @@ function isPublic(block) {
   return !block.isPrivate && !block.ignore;
 }
 
+function isMethod(block) {
+  var tag = block.tags[0];
+  return tag && tag.type !== 'typedef';
+}
+
 function detectLinks(str) {
   var reg = /\[([^\]]*)]{@link ([^}]*)}/g;
 
@@ -118,7 +123,7 @@ function getName(block) {
     return alias.string;
   }
 
-  return block.ctx.name;
+  return block.ctx && block.ctx.name;
 }
 
 function getClassDesc(block) {
@@ -302,6 +307,7 @@ function parseFile(fileName, contents, umbrellaMode) {
     parent: parent,
     children: getChildren(id),
     methods: comments
+      .filter(isMethod)
       .map(createMethod.bind(null, fileName, id))
       .concat(getMixinMethods(comments))
       .reduce(createUniqueMethodList, [])