Skip to content

Commit

Permalink
docs: update jsdoc license/samples-README (#336)
Browse files Browse the repository at this point in the history
  • Loading branch information
bcoe authored Dec 26, 2019
1 parent a373db7 commit 8f82c5d
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 25 deletions.
29 changes: 14 additions & 15 deletions packages/google-cloud-videointelligence/.jsdoc.js
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
/*!
* Copyright 2018 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.
*/
// Copyright 2019 Google LLC
//
// 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
//
// https://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';

Expand Down
26 changes: 16 additions & 10 deletions packages/google-cloud-videointelligence/samples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,12 @@
Before running the samples, make sure you've followed the steps outlined in
[Using the client library](https://github.com/googleapis/nodejs-video-intelligence#using-the-client-library).

`cd samples`

`npm install`

`cd ..`

## Samples


Expand All @@ -40,7 +46,7 @@ View the [source code](https://github.com/googleapis/nodejs-video-intelligence/b
__Usage:__


`node analyze-streaming-annotation-to-storage.js`
`node samples/analyze-streaming-annotation-to-storage.js`


-----
Expand All @@ -57,7 +63,7 @@ View the [source code](https://github.com/googleapis/nodejs-video-intelligence/b
__Usage:__


`node analyze-streaming-automl-classification.js`
`node samples/analyze-streaming-automl-classification.js`


-----
Expand All @@ -74,7 +80,7 @@ View the [source code](https://github.com/googleapis/nodejs-video-intelligence/b
__Usage:__


`node analyze-streaming-labels.js`
`node samples/analyze-streaming-labels.js`


-----
Expand All @@ -91,7 +97,7 @@ View the [source code](https://github.com/googleapis/nodejs-video-intelligence/b
__Usage:__


`node analyze-streaming-object.js`
`node samples/analyze-streaming-object.js`


-----
Expand All @@ -108,7 +114,7 @@ View the [source code](https://github.com/googleapis/nodejs-video-intelligence/b
__Usage:__


`node analyze-streaming-safe-search.js`
`node samples/analyze-streaming-safe-search.js`


-----
Expand All @@ -125,7 +131,7 @@ View the [source code](https://github.com/googleapis/nodejs-video-intelligence/b
__Usage:__


`node analyze-streaming-shot-change.js`
`node samples/analyze-streaming-shot-change.js`


-----
Expand All @@ -142,7 +148,7 @@ View the [source code](https://github.com/googleapis/nodejs-video-intelligence/b
__Usage:__


`node analyze.js`
`node samples/analyze.js`


-----
Expand All @@ -159,7 +165,7 @@ View the [source code](https://github.com/googleapis/nodejs-video-intelligence/b
__Usage:__


`node analyze.v1p2beta1.js`
`node samples/analyze.v1p2beta1.js`


-----
Expand All @@ -176,7 +182,7 @@ View the [source code](https://github.com/googleapis/nodejs-video-intelligence/b
__Usage:__


`node quickstart.js`
`node samples/quickstart.js`



Expand All @@ -185,4 +191,4 @@ __Usage:__

[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
[shell_link]: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-intelligence&page=editor&open_in_editor=samples/README.md
[product-docs]: https://cloud.google.com/video-intelligence
[product-docs]: https://cloud.google.com/video-intelligence

0 comments on commit 8f82c5d

Please sign in to comment.