From 4afadaeb84113bfae3733d32c16ed85d79c8564c Mon Sep 17 00:00:00 2001 From: Summer Ji Date: Wed, 26 Feb 2020 14:32:17 -0800 Subject: [PATCH] fix: template for configuring jsdoc (#298) --- baselines/dlp/.jsdoc.js.baseline | 7 +++++-- baselines/kms/.jsdoc.js.baseline | 7 +++++-- baselines/monitoring/.jsdoc.js.baseline | 7 +++++-- baselines/redis/.jsdoc.js.baseline | 7 +++++-- baselines/showcase/.jsdoc.js.baseline | 7 +++++-- baselines/texttospeech/.jsdoc.js.baseline | 7 +++++-- baselines/translate/.jsdoc.js.baseline | 7 +++++-- templates/typescript_gapic/.jsdoc.js.njk | 7 +++++-- 8 files changed, 40 insertions(+), 16 deletions(-) diff --git a/baselines/dlp/.jsdoc.js.baseline b/baselines/dlp/.jsdoc.js.baseline index 0a633a11b..b2261b00c 100644 --- a/baselines/dlp/.jsdoc.js.baseline +++ b/baselines/dlp/.jsdoc.js.baseline @@ -39,8 +39,11 @@ module.exports = { copyright: 'Copyright 2019 Google, LLC.', includeDate: false, sourceFiles: false, - systemName: 'Dlp', - theme: 'lumen' + systemName: 'dlp', + theme: 'lumen', + default: { + "outputSourceFiles": false + } }, markdown: { idInHeadings: true diff --git a/baselines/kms/.jsdoc.js.baseline b/baselines/kms/.jsdoc.js.baseline index f42e03781..e0b7b2840 100644 --- a/baselines/kms/.jsdoc.js.baseline +++ b/baselines/kms/.jsdoc.js.baseline @@ -39,8 +39,11 @@ module.exports = { copyright: 'Copyright 2019 Google, LLC.', includeDate: false, sourceFiles: false, - systemName: 'Kms', - theme: 'lumen' + systemName: 'kms', + theme: 'lumen', + default: { + "outputSourceFiles": false + } }, markdown: { idInHeadings: true diff --git a/baselines/monitoring/.jsdoc.js.baseline b/baselines/monitoring/.jsdoc.js.baseline index 65303f3e4..b3e5200b4 100644 --- a/baselines/monitoring/.jsdoc.js.baseline +++ b/baselines/monitoring/.jsdoc.js.baseline @@ -39,8 +39,11 @@ module.exports = { copyright: 'Copyright 2019 Google, LLC.', includeDate: false, sourceFiles: false, - systemName: 'Monitoring', - theme: 'lumen' + systemName: 'monitoring', + theme: 'lumen', + default: { + "outputSourceFiles": false + } }, markdown: { idInHeadings: true diff --git a/baselines/redis/.jsdoc.js.baseline b/baselines/redis/.jsdoc.js.baseline index bdafaf5de..f58d23626 100644 --- a/baselines/redis/.jsdoc.js.baseline +++ b/baselines/redis/.jsdoc.js.baseline @@ -39,8 +39,11 @@ module.exports = { copyright: 'Copyright 2019 Google, LLC.', includeDate: false, sourceFiles: false, - systemName: 'Redis', - theme: 'lumen' + systemName: 'redis', + theme: 'lumen', + default: { + "outputSourceFiles": false + } }, markdown: { idInHeadings: true diff --git a/baselines/showcase/.jsdoc.js.baseline b/baselines/showcase/.jsdoc.js.baseline index 8f27315b3..bf9098731 100644 --- a/baselines/showcase/.jsdoc.js.baseline +++ b/baselines/showcase/.jsdoc.js.baseline @@ -39,8 +39,11 @@ module.exports = { copyright: 'Copyright 2019 Google, LLC.', includeDate: false, sourceFiles: false, - systemName: 'Showcase', - theme: 'lumen' + systemName: 'showcase', + theme: 'lumen', + default: { + "outputSourceFiles": false + } }, markdown: { idInHeadings: true diff --git a/baselines/texttospeech/.jsdoc.js.baseline b/baselines/texttospeech/.jsdoc.js.baseline index a07cde638..b2a0a765f 100644 --- a/baselines/texttospeech/.jsdoc.js.baseline +++ b/baselines/texttospeech/.jsdoc.js.baseline @@ -39,8 +39,11 @@ module.exports = { copyright: 'Copyright 2019 Google, LLC.', includeDate: false, sourceFiles: false, - systemName: 'Texttospeech', - theme: 'lumen' + systemName: '@google-cloud/text-to-speech', + theme: 'lumen', + default: { + "outputSourceFiles": false + } }, markdown: { idInHeadings: true diff --git a/baselines/translate/.jsdoc.js.baseline b/baselines/translate/.jsdoc.js.baseline index 0d6b78cca..c4bdeb47a 100644 --- a/baselines/translate/.jsdoc.js.baseline +++ b/baselines/translate/.jsdoc.js.baseline @@ -39,8 +39,11 @@ module.exports = { copyright: 'Copyright 2019 Google, LLC.', includeDate: false, sourceFiles: false, - systemName: 'Translation', - theme: 'lumen' + systemName: 'translation', + theme: 'lumen', + default: { + "outputSourceFiles": false + } }, markdown: { idInHeadings: true diff --git a/templates/typescript_gapic/.jsdoc.js.njk b/templates/typescript_gapic/.jsdoc.js.njk index 05ce4ea5e..260266bab 100644 --- a/templates/typescript_gapic/.jsdoc.js.njk +++ b/templates/typescript_gapic/.jsdoc.js.njk @@ -39,8 +39,11 @@ module.exports = { copyright: 'Copyright 2019 Google, LLC.', includeDate: false, sourceFiles: false, - systemName: '{{ api.naming.name }}', - theme: 'lumen' + systemName: '{{ api.publishName }}', + theme: 'lumen', + default: { + "outputSourceFiles": false + } }, markdown: { idInHeadings: true