Skip to content

Commit

Permalink
docs: update return type in jsdoc for Buffers (#256)
Browse files Browse the repository at this point in the history
  • Loading branch information
yoshi-automation authored and JustinBeckwith committed Jun 12, 2019
1 parent 6888f98 commit c55e116
Show file tree
Hide file tree
Showing 17 changed files with 24 additions and 24 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* '?' to match 1 character. If unset, the input video should be embedded
* in the request as `input_content`. If set, `input_content` should be unset.
*
* @property {string} inputContent
* @property {Buffer} inputContent
* The video data bytes.
* If unset, the input video(s) should be specified via `input_uri`.
* If set, `input_uri` should be unset.
Expand Down Expand Up @@ -479,7 +479,7 @@ const FaceFrame = {
/**
* Face annotation.
*
* @property {string} thumbnail
* @property {Buffer} thumbnail
* Thumbnail of a representative face view (in JPEG format).
*
* @property {Object[]} segments
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@
* Schemes other than `http`, `https` (or the empty scheme) might be
* used with implementation specific semantics.
*
* @property {string} value
* @property {Buffer} value
* Must be a valid serialized protocol buffer of the above specified type.
*
* @typedef Any
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ class VideoIntelligenceServiceClient {
* videos. Supported wildcards: '*' to match 0 or more characters;
* '?' to match 1 character. If unset, the input video should be embedded
* in the request as `input_content`. If set, `input_content` should be unset.
* @param {string} [request.inputContent]
* @param {Buffer} [request.inputContent]
* The video data bytes.
* If unset, the input video(s) should be specified via `input_uri`.
* If set, `input_uri` should be unset.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@
* Schemes other than `http`, `https` (or the empty scheme) might be
* used with implementation specific semantics.
*
* @property {string} value
* @property {Buffer} value
* Must be a valid serialized protocol buffer of the above specified type.
*
* @typedef Any
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* '?' to match 1 character. If unset, the input video should be embedded
* in the request as `input_content`. If set, `input_content` should be unset.
*
* @property {string} inputContent
* @property {Buffer} inputContent
* The video data bytes.
* If unset, the input video(s) should be specified via `input_uri`.
* If set, `input_uri` should be unset.
Expand Down Expand Up @@ -409,7 +409,7 @@ const FaceFrame = {
/**
* Face annotation.
*
* @property {string} thumbnail
* @property {Buffer} thumbnail
* Thumbnail of a representative face view (in JPEG format).
*
* @property {Object[]} segments
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@
* Schemes other than `http`, `https` (or the empty scheme) might be
* used with implementation specific semantics.
*
* @property {string} value
* @property {Buffer} value
* Must be a valid serialized protocol buffer of the above specified type.
*
* @typedef Any
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ class VideoIntelligenceServiceClient {
* videos. Supported wildcards: '*' to match 0 or more characters;
* '?' to match 1 character. If unset, the input video should be embedded
* in the request as `input_content`. If set, `input_content` should be unset.
* @param {string} [request.inputContent]
* @param {Buffer} [request.inputContent]
* The video data bytes.
* If unset, the input video(s) should be specified via `input_uri`.
* If set, `input_uri` should be unset.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* '?' to match 1 character. If unset, the input video should be embedded
* in the request as `input_content`. If set, `input_content` should be unset.
*
* @property {string} inputContent
* @property {Buffer} inputContent
* The video data bytes.
* If unset, the input video(s) should be specified via `input_uri`.
* If set, `input_uri` should be unset.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@
* Schemes other than `http`, `https` (or the empty scheme) might be
* used with implementation specific semantics.
*
* @property {string} value
* @property {Buffer} value
* Must be a valid serialized protocol buffer of the above specified type.
*
* @typedef Any
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ class VideoIntelligenceServiceClient {
* videos. Supported wildcards: '*' to match 0 or more characters;
* '?' to match 1 character. If unset, the input video should be embedded
* in the request as `input_content`. If set, `input_content` should be unset.
* @param {string} [request.inputContent]
* @param {Buffer} [request.inputContent]
* The video data bytes.
* If unset, the input video(s) should be specified via `input_uri`.
* If set, `input_uri` should be unset.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* '?' to match 1 character. If unset, the input video should be embedded
* in the request as `input_content`. If set, `input_content` should be unset.
*
* @property {string} inputContent
* @property {Buffer} inputContent
* The video data bytes.
* If unset, the input video(s) should be specified via `input_uri`.
* If set, `input_uri` should be unset.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@
* Schemes other than `http`, `https` (or the empty scheme) might be
* used with implementation specific semantics.
*
* @property {string} value
* @property {Buffer} value
* Must be a valid serialized protocol buffer of the above specified type.
*
* @typedef Any
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ class VideoIntelligenceServiceClient {
* videos. Supported wildcards: '*' to match 0 or more characters;
* '?' to match 1 character. If unset, the input video should be embedded
* in the request as `input_content`. If set, `input_content` should be unset.
* @param {string} [request.inputContent]
* @param {Buffer} [request.inputContent]
* The video data bytes.
* If unset, the input video(s) should be specified via `input_uri`.
* If set, `input_uri` should be unset.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* '?' to match 1 character. If unset, the input video should be embedded
* in the request as `input_content`. If set, `input_content` should be unset.
*
* @property {string} inputContent
* @property {Buffer} inputContent
* The video data bytes.
* If unset, the input video(s) should be specified via `input_uri`.
* If set, `input_uri` should be unset.
Expand Down Expand Up @@ -1040,7 +1040,7 @@ const LogoRecognitionAnnotation = {
*
* This object should have the same structure as [StreamingVideoConfig]{@link google.cloud.videointelligence.v1p3beta1.StreamingVideoConfig}
*
* @property {string} inputContent
* @property {Buffer} inputContent
* The video data to be annotated. Chunks of video data are sequentially
* sent in `StreamingAnnotateVideoRequest` messages. Except the initial
* `StreamingAnnotateVideoRequest` message containing only
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@
* Schemes other than `http`, `https` (or the empty scheme) might be
* used with implementation specific semantics.
*
* @property {string} value
* @property {Buffer} value
* Must be a valid serialized protocol buffer of the above specified type.
*
* @typedef Any
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ class VideoIntelligenceServiceClient {
* videos. Supported wildcards: '*' to match 0 or more characters;
* '?' to match 1 character. If unset, the input video should be embedded
* in the request as `input_content`. If set, `input_content` should be unset.
* @param {string} [request.inputContent]
* @param {Buffer} [request.inputContent]
* The video data bytes.
* If unset, the input video(s) should be specified via `input_uri`.
* If set, `input_uri` should be unset.
Expand Down
10 changes: 5 additions & 5 deletions packages/google-cloud-videointelligence/synth.metadata
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
{
"updateTime": "2019-06-11T11:26:33.284075Z",
"updateTime": "2019-06-12T11:28:03.051269Z",
"sources": [
{
"generator": {
"name": "artman",
"version": "0.24.0",
"dockerImage": "googleapis/artman@sha256:ce425884865f57f18307e597bca1a74a3619b7098688d4995261f3ffb3488681"
"version": "0.24.1",
"dockerImage": "googleapis/artman@sha256:6018498e15310260dc9b03c9d576608908ed9fbabe42e1494ff3d827fea27b19"
}
},
{
"git": {
"name": "googleapis",
"remote": "https://github.com/googleapis/googleapis.git",
"sha": "744feb9660b3194fcde37dea50038bde204f3573",
"internalRef": "252553801"
"sha": "f117dac435e96ebe58d85280a3faf2350c4d4219",
"internalRef": "252714985"
}
},
{
Expand Down

0 comments on commit c55e116

Please sign in to comment.