Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Review and Enhance JavaDocs in Storage Blobs #4047

Closed
jianghaolu opened this issue Jun 21, 2019 · 3 comments
Closed

Review and Enhance JavaDocs in Storage Blobs #4047

jianghaolu opened this issue Jun 21, 2019 · 3 comments
Labels
Client This issue points to a problem in the data-plane of the library. Docs help wanted This issue is tracking work for which community contributions would be welcomed and appreciated Storage Storage Service (Queues, Blobs, Files)
Milestone

Comments

@jianghaolu
Copy link
Contributor

No description provided.

@jianghaolu jianghaolu added Storage Storage Service (Queues, Blobs, Files) Client This issue points to a problem in the data-plane of the library. labels Jun 21, 2019
@jianghaolu jianghaolu self-assigned this Jun 21, 2019
@alzimmermsft alzimmermsft changed the title Add more docs on max overloads in blob client Review and Enhance JavaDocs in Storage Blobs Aug 7, 2019
@vhvb1989
Copy link
Member

hey @jianghaolu , is this the same as #5187?
Can we close this one as duplicated of that one? or is there something else you would like for this one to be implemented?

@rickle-msft
Copy link
Contributor

The Javadoc comments for Storage Blobs do not seem to correspond with the SDK. For example,
in BlobContainerAsynClient getBlobAsyncClient(String) it says, but it should refer to the builder.

/**
 * Creates a new BlobAsyncClient object by concatenating blobName to the end of ContainerAsyncClient's URL. The new
 * BlobAsyncClient uses the same request policy pipeline as the ContainerAsyncClient. To change the pipeline, create
 * the BlobAsyncClient and then call its WithPipeline method passing in the desired pipeline object. Or, call this
 * package's getBlobAsyncClient instead of calling this object's getBlobAsyncClient method.
 *
 * <p><strong>Code Samples</strong></p>
 *
 * {@codesnippet com.azure.storage.blob.BlobContainerAsyncClient.getBlobAsyncClient#String}
 *
 * @param blobName A {@code String} representing the name of the blob.
 * @return A new {@link BlobAsyncClient} object which references the blob with the specified name in this container.
 */

@joshfree joshfree added Docs help wanted This issue is tracking work for which community contributions would be welcomed and appreciated labels Nov 12, 2019
@joshfree joshfree added this to the Backlog milestone Jul 7, 2020
@alzimmermsft
Copy link
Member

Closing as Storage Blobs documentation has been reviewed and enhanced with code samples and further details.

@github-actions github-actions bot locked and limited conversation to collaborators Apr 13, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Client This issue points to a problem in the data-plane of the library. Docs help wanted This issue is tracking work for which community contributions would be welcomed and appreciated Storage Storage Service (Queues, Blobs, Files)
Projects
None yet
Development

No branches or pull requests

5 participants