Skip to content

Commit

Permalink
Merge pull request #5 from jianghaolu/storage-doc2
Browse files Browse the repository at this point in the history
Add line breaks to class level docs
  • Loading branch information
jaschrep-msft authored Jun 12, 2019
2 parents 70fe2ac + 4009eca commit e55e317
Show file tree
Hide file tree
Showing 12 changed files with 62 additions and 27 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,14 @@
* the method {@link BlobAsyncClient#asAppendBlobAsyncClient()}, or via the method
* {@link ContainerAsyncClient#createAppendBlobAsyncClient(String)}. This class does not hold
* any state about a particular blob, but is instead a convenient way of sending appropriate
* requests to the resource on the service. Please refer to the
* <a href=https://docs.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs>Azure Docs</a>
* for more information on append blobs.
* requests to the resource on the service.
*
* <p>
* Please refer
* to the <a href=https://docs.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs>Azure Docs</a>
* for more information.
*
* <p>
* Note this client is an async client that returns reactive responses from Spring Reactor Core
* project (https://projectreactor.io/). Calling the methods in this client will <strong>NOT</strong>
* start the actual network operation, until {@code .subscribe()} is called on the reactive response.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,11 @@
* the method {@link BlobClient#asAppendBlobClient()}, or via the method
* {@link ContainerClient#createAppendBlobClient(String)}. This class does not hold
* any state about a particular blob, but is instead a convenient way of sending appropriate
* requests to the resource on the service. Please refer to the
* <a href=https://docs.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs>Azure Docs</a>
* for more information on append blobs.
* requests to the resource on the service.
*
* <p>
* Please refer to the <a href=https://docs.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs>Azure Docs</a>
* for more information.
*/
public final class AppendBlobClient extends BlobClient {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,17 @@
/**
* Client to a blob of any type: block, append, or page. It may be obtained through a {@link BlobClientBuilder} or via
* the method {@link ContainerAsyncClient#createBlobAsyncClient(String)}. This class does not hold any state about a particular
* blob, but is instead a convenient way of sending appropriate requests to the resource on the service. Please refer
* to the <a href=https://docs.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs>Azure Docs</a>
* blob, but is instead a convenient way of sending appropriate requests to the resource on the service.
*
* <p>
* This client offers the ability to download blobs. Note that uploading data is specific to each type of blob. Please
* refer to the {@link BlockBlobAsyncClient}, {@link PageBlobAsyncClient}, or {@link AppendBlobAsyncClient} for upload
* options.
* refer to the {@link BlockBlobClient}, {@link PageBlobClient}, or {@link AppendBlobClient} for upload options.
*
* <p>
* Please refer to the <a href=https://docs.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs>Azure Docs</a>
* for more information.
*
* <p>
* Note this client is an async client that returns reactive responses from Spring Reactor Core
* project (https://projectreactor.io/). Calling the methods in this client will <strong>NOT</strong>
* start the actual network operation, until {@code .subscribe()} is called on the reactive response.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,15 @@
/**
* Client to a blob of any type: block, append, or page. It may be obtained through a {@link BlobClientBuilder} or via
* the method {@link ContainerClient#createBlobClient(String)}. This class does not hold any state about a particular
* blob, but is instead a convenient way of sending appropriate requests to the resource on the service. Please refer
* to the <a href=https://docs.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs>Azure Docs</a>
* for more information.
* blob, but is instead a convenient way of sending appropriate requests to the resource on the service.
*
* <p>
* This client offers the ability to download blobs. Note that uploading data is specific to each type of blob. Please
* refer to the {@link BlockBlobClient}, {@link PageBlobClient}, or {@link AppendBlobClient} for upload options.
*
* <p>
* Please refer to the <a href=https://docs.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs>Azure Docs</a>
* for more information.
*/
public class BlobClient {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,12 @@
* This class does not hold any state about a particular storage account but is
* instead a convenient way of sending off appropriate requests to the resource on the service.
* It may also be used to construct URLs to blobs and containers.
*
* <p>
* Please see <a href=https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction>here</a> for more
* information on containers.
*
* <p>
* Note this client is an async client that returns reactive responses from Spring Reactor Core
* project (https://projectreactor.io/). Calling the methods in this client will <strong>NOT</strong>
* start the actual network operation, until {@code .subscribe()} is called on the reactive response.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@
* This class does not hold any state about a particular storage account but is
* instead a convenient way of sending off appropriate requests to the resource on the service.
* It may also be used to construct URLs to blobs and containers.
*
* <p>
* Please see <a href=https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction>here</a> for more
* information on containers.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,14 @@
* the method {@link BlobAsyncClient#asBlockBlobAsyncClient()}, or via the method
* {@link ContainerAsyncClient#createBlockBlobAsyncClient(String)}. This class does not hold
* any state about a particular blob, but is instead a convenient way of sending appropriate
* requests to the resource on the service. Please refer to the
* <a href=https://docs.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs>Azure Docs</a>
* for more information on block blobs.
* requests to the resource on the service.
*
* <p>
* Please refer
* to the <a href=https://docs.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs>Azure Docs</a>
* for more information.
*
* <p>
* Note this client is an async client that returns reactive responses from Spring Reactor Core
* project (https://projectreactor.io/). Calling the methods in this client will <strong>NOT</strong>
* start the actual network operation, until {@code .subscribe()} is called on the reactive response.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,11 @@
* the method {@link BlobClient#asBlockBlobClient()}, or via the method
* {@link ContainerClient#createBlockBlobClient(String)}. This class does not hold
* any state about a particular blob, but is instead a convenient way of sending appropriate
* requests to the resource on the service. Please refer to the
* <a href=https://docs.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs>Azure Docs</a>
* for more information on block blobs.
* requests to the resource on the service.
*
* <p>
* Please refer to the <a href=https://docs.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs>Azure Docs</a>
* for more information.
*/
public final class BlockBlobClient extends BlobClient {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,13 @@
* Client to a container. It may be obtained through a {@link ContainerClientBuilder} or via the method
* {@link BlobServiceAsyncClient#createContainerAsyncClient(String)}. This class does not hold any
* state about a particular blob but is instead a convenient way of sending off appropriate requests to
* the resource on the service. It may also be used to construct URLs to blobs. Please refer to the
* <a href=https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction>Azure Docs</a>
* the resource on the service. It may also be used to construct URLs to blobs.
*
* <p>
* Please refer to the <a href=https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction>Azure Docs</a>
* for more information on containers.
*
* <p>
* Note this client is an async client that returns reactive responses from Spring Reactor Core
* project (https://projectreactor.io/). Calling the methods in this client will <strong>NOT</strong>
* start the actual network operation, until {@code .subscribe()} is called on the reactive response.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,10 @@
* Client to a container. It may be obtained through a {@link ContainerClientBuilder} or via the method
* {@link BlobServiceClient#createContainerClient(String)}. This class does not hold any
* state about a particular blob but is instead a convenient way of sending off appropriate requests to
* the resource on the service. It may also be used to construct URLs to blobs. Please refer to the
* <a href=https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction>Azure Docs</a>
* the resource on the service. It may also be used to construct URLs to blobs.
*
* <p>
* Please refer to the <a href=https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction>Azure Docs</a>
* for more information on containers.
*/
public final class ContainerClient {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,14 @@
* the method {@link BlobAsyncClient#asPageBlobAsyncClient()}, or via the method
* {@link ContainerAsyncClient#createPageBlobAsyncClient(String)}. This class does not hold
* any state about a particular blob, but is instead a convenient way of sending appropriate
* requests to the resource on the service. Please refer to the
* <a href=https://docs.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs>Azure Docs</a>
* requests to the resource on the service.
*
* <p>
* Please refer
* to the <a href=https://docs.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs>Azure Docs</a>
* for more information.
*
* <p>
* Note this client is an async client that returns reactive responses from Spring Reactor Core
* project (https://projectreactor.io/). Calling the methods in this client will <strong>NOT</strong>
* start the actual network operation, until {@code .subscribe()} is called on the reactive response.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,10 @@
* the method {@link BlobClient#asPageBlobClient()}, or via the method
* {@link ContainerClient#createPageBlobClient(String)}. This class does not hold
* any state about a particular blob, but is instead a convenient way of sending appropriate
* requests to the resource on the service. Please refer to the
* <a href=https://docs.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs>Azure Docs</a>
* requests to the resource on the service.
*
* <p>
* Please refer to the <a href=https://docs.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs>Azure Docs</a>
* for more information.
*/
public final class PageBlobClient extends BlobClient {
Expand Down

0 comments on commit e55e317

Please sign in to comment.