Work around typedoc issue

where comments are not rendered when there are brackets around optional parameter name (TypeStrong/typedoc#567).
jeremymeng · Apr 23, 2019 · d2e29d8 · d2e29d8
1 parent 5861068
commit d2e29d8
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/sdk/storage/storage-blob/src/highlevel.browser.ts b/sdk/storage/storage-blob/src/highlevel.browser.ts
@@ -67,7 +67,7 @@ export async function uploadBrowserDataToBlockBlob(
  * @export
  * @param {Blob | ArrayBuffer | ArrayBufferView} browserData Blob, File, ArrayBuffer or ArrayBufferView
  * @param {BlockBlobURL} blockBlobURL
- * @param {IUploadToBlockBlobOptions & CredentialOptions & INewPipelineOptions} [options] Options for Uploading browser data, credential, and new pipeline.
+ * @param {IUploadToBlockBlobOptions & CredentialOptions & INewPipelineOptions} options Options for Uploading browser data, credential, and new pipeline.
  *                                                           If credential options is not specified {@link AnonymousCredential} is used.
  * @returns {Promise<BlobUploadCommonResponse>}
  */

diff --git a/sdk/storage/storage-blob/src/highlevel.node.ts b/sdk/storage/storage-blob/src/highlevel.node.ts
@@ -79,8 +79,8 @@ export type UploadFileToBlockBlobUrlOptions = IUploadToBlockBlobOptions & Creden
  * @export
  * @param {string} filePath Full path of local file
  * @param {string} blockBlobURL url to a block blob
- * @param {UploadFileToBlockBlobUrlOptions} [options] IUploadToBlockBlobOptions & CredentialOptions & INewPipelineOptions.
- *                                                    If credential options is not specified {@link AnonymousCredential} is used.
+ * @param {UploadFileToBlockBlobUrlOptions} options IUploadToBlockBlobOptions & CredentialOptions & INewPipelineOptions.
+ *                                                  If credential options is not specified {@link AnonymousCredential} is used.
  * @returns {(Promise<BlobUploadCommonResponse>)} ICommonResponse
  */
 export async function uploadFileToBlockBlobUrl(
@@ -315,8 +315,8 @@ export type DownloadBlobToBufferFromUrlOptions = IDownloadFromBlobOptions & Cred
  * @param {BlobURL} blobURL A BlobURL object
  * @param {number} [offset] From which position of the block blob to download
  * @param {number} [count] How much data to be downloaded. Will download to the end when passing undefined
- * @param {DownloadBlobToBufferFromUrlOptions} [options] IDownloadFromBlobOptions & CredentialOptions & INewPipelineOptions.
- *                                                       If credential options is not specified {@link AnonymousCredential} is used.
+ * @param {DownloadBlobToBufferFromUrlOptions} options IDownloadFromBlobOptions & CredentialOptions & INewPipelineOptions.
+ *                                                     If credential options is not specified {@link AnonymousCredential} is used.
  * @param {credential} [credential] Credential. If not specified {@link AnonymousCredential} is used.
  * @param {INewPipelineOptions} [pipelineOptions]
  * @returns {Promise<void>}
@@ -474,8 +474,8 @@ export type UploadStreamToBlockBlobUrlOptions = IUploadStreamToBlockBlobOptions
  * @param {number} bufferSize Size of every buffer allocated, also the block size in the uploaded block blob
  * @param {number} maxBuffers Max buffers will allocate during uploading, positive correlation
  *                            with max uploading concurrency
- * @param {UploadStreamToBlockBlobUrlOptions} [options] IUploadStreamToBlockBlobOptions & CredentialOptions & INewPipelineOptions.
- *                                            If credential options is not specified {@link AnonymousCredential} is used.
+ * @param {UploadStreamToBlockBlobUrlOptions} options IUploadStreamToBlockBlobOptions & CredentialOptions & INewPipelineOptions.
+ *                                                    If credential options is not specified {@link AnonymousCredential} is used.
  * @returns {Promise<BlobUploadCommonResponse>}
  */
 export async function uploadStreamToBlockBlobUrl(