Skip to content

docs: catch actual exception in java doc comment #312

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
May 13, 2020
Merged

docs: catch actual exception in java doc comment #312

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
47dcb7f
docs: catch actual exception in java doc comment
suraj-qlogic May 12, 2020
16cf135
docs: fix review changes
suraj-qlogic May 12, 2020
bed6047
docs: fix review changes
suraj-qlogic May 13, 2020
7db165e
docs: fix review changes
suraj-qlogic May 13, 2020
f320ab8
docs: fix review changes
suraj-qlogic May 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions google-cloud-storage/src/main/java/com/google/cloud/storage/Blob.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -726,11 +726,9 @@ public ReadChannel reader(BlobSourceOption... options) {
* <pre>{@code
* byte[] content = "Hello, World!".getBytes(UTF_8);
* try (WriteChannel writer = blob.writer()) {
Copy link
Contributor

@elharo elharo May 12, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no need for the nested try block, one will do here

Copy link
Contributor Author

@suraj-qlogic suraj-qlogic May 12, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

* try {
* writer.write(ByteBuffer.wrap(content, 0, content.length));
* } catch (Exception ex) {
* // handle exception
* }
* } catch (IOException ex) {
* // handle exception
* }
* }</pre>
Copy link
Contributor

@elharo elharo May 13, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you still have an extra closing brace

Copy link
Contributor Author

@suraj-qlogic suraj-qlogic May 13, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@elharo ,I have gone throught code and found there is no extra closing brace.Here last closing brace indicate closing of {@code } tag.Can you please look once?

Copy link
Contributor

@elharo elharo May 13, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

line 733, just before , same below

Copy link
Contributor Author

@suraj-qlogic suraj-qlogic May 13, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@elharo

   * <pre>{@code
   * byte[] content = "Hello, World!".getBytes(UTF_8);
   * try (WriteChannel writer = blob.writer()) {
   *     writer.write(ByteBuffer.wrap(content, 0, content.length));
   * } catch (IOException ex) {
   *   // handle exception
   * }
   * }</pre>

Here First closing } brace indicate closing of try block,Second } brace indicate closing
for catch clause.and last one } indicate closing of <pre>{@code so can we write document comment without ending <pre>{@code?

Copy link
Contributor

@elharo elharo May 13, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By my count you have two open braces and three close braces. Change line 733 from

}</pre> to </pre>

Copy link
Contributor Author

@suraj-qlogic suraj-qlogic May 13, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

*
Expand Down
6 changes: 2 additions & 4 deletions google-cloud-storage/src/main/java/com/google/cloud/storage/Storage.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2503,11 +2503,9 @@ Blob create(
* byte[] content = "Hello, World!".getBytes(UTF_8);
* BlobInfo blobInfo = BlobInfo.newBuilder(blobId).setContentType("text/plain").build();
* try (WriteChannel writer = storage.writer(blobInfo)) {
Copy link
Contributor

@elharo elharo May 12, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

don't nest the try block, one is enough

Copy link
Contributor Author

@suraj-qlogic suraj-qlogic May 12, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

* try {
* writer.write(ByteBuffer.wrap(content, 0, content.length));
* } catch (Exception ex) {
* // handle exception
* }
* } catch (IOException ex) {
* // handle exception
* }
* }</pre>
Copy link
Contributor

@elharo elharo May 13, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

extra close brace

Copy link
Contributor Author

@suraj-qlogic suraj-qlogic May 13, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above.

*
Expand Down