-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: generate .jsdoc.js for client library (#128)
* generate .jsdoc.js for client * update baseline * sort package.json dependency * add linkinator docs test * update baseline * add predocs-test * add proto types to jsdoc * add docs-test to circleCU * add new line * Update config.yml
- Loading branch information
1 parent
9588ddf
commit 6d23093
Showing
17 changed files
with
410 additions
and
102 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| /*! | ||
| * Copyright 2019 Google LLC. All Rights Reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| 'use strict'; | ||
|
|
||
| module.exports = { | ||
| opts: { | ||
| package: './package.json', | ||
| template: './node_modules/jsdoc-fresh', | ||
| recurse: true, | ||
| verbose: true, | ||
| destination: './docs/' | ||
| }, | ||
| plugins: [ | ||
| 'plugins/markdown' | ||
| ], | ||
| source: { | ||
| include: [ | ||
| 'build/src', | ||
| 'protos' | ||
| ], | ||
| includePattern: '\\.js$' | ||
| }, | ||
| templates: { | ||
| copyright: 'Copyright 2019 Google, LLC.', | ||
| includeDate: false, | ||
| sourceFiles: false, | ||
| systemName: '{{ api.naming.name }}', | ||
| theme: 'lumen' | ||
| }, | ||
| markdown: { | ||
| idInHeadings: true | ||
| } | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "recurse": true, | ||
| "skip": [ | ||
| "https://codecov.io/gh/googleapis/", | ||
| "www.googleapis.com" | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| /*! | ||
| * Copyright 2019 Google LLC. All Rights Reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| 'use strict'; | ||
|
|
||
| module.exports = { | ||
| opts: { | ||
| package: './package.json', | ||
| template: './node_modules/jsdoc-fresh', | ||
| recurse: true, | ||
| verbose: true, | ||
| destination: './docs/' | ||
| }, | ||
| plugins: [ | ||
| 'plugins/markdown' | ||
| ], | ||
| source: { | ||
| include: [ | ||
| 'build/src', | ||
| 'protos' | ||
| ], | ||
| includePattern: '\\.js$' | ||
| }, | ||
| templates: { | ||
| copyright: 'Copyright 2019 Google, LLC.', | ||
| includeDate: false, | ||
| sourceFiles: false, | ||
| systemName: 'Kms', | ||
| theme: 'lumen' | ||
| }, | ||
| markdown: { | ||
| idInHeadings: true | ||
| } | ||
| }; |
7 changes: 7 additions & 0 deletions
7
typescript/test/testdata/keymanager/linkinator.config.json.baseline
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "recurse": true, | ||
| "skip": [ | ||
| "https://codecov.io/gh/googleapis/", | ||
| "www.googleapis.com" | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.