doc(storage): improve {Bucket,Object}Metadata docs#8434
Merged
coryan merged 2 commits intoFeb 23, 2022
Conversation
The documentation was not rendering correctly. It was reusing the description from one function to many unrelated functions. In addition, the groups were also rendering incorrectly. After re-reading the Doxygen documentation it seems that ```cc /// @name Group description ///@{ ... grouped member functions ///@} ``` Is the "Right Thing":tm:
product-auto-label
Bot
added
the
api: storage
Contributor
|
Google Cloud Build Logs
ℹ️ NOTE: Kokoro logs are linked from "Details" below. |
Contributor
Author
|
Rendered to PDF: |
Codecov Report
@@ Coverage Diff @@
## main #8434 +/- ##
=======================================
Coverage 95.09% 95.09%
=======================================
Files 1366 1366
Lines 122339 122339
=======================================
+ Hits 116335 116338 +3
+ Misses 6004 6001 -3
Continue to review full report at Codecov.
|
dbolduc
approved these changes
Feb 23, 2022
| return *this; | ||
| } | ||
|
|
||
| /// Returns all the Object's metadata entries, |
| //@} | ||
| ///@} | ||
|
|
||
| /// Returns `true` if the object has a `owner` attributes. |
| /** | ||
| * The generation of the object metadata. | ||
| * | ||
| * Note that changes to the object metadata (e.g. changing the `cacheControl` |
Contributor
|
Google Cloud Build Logs
ℹ️ NOTE: Kokoro logs are linked from "Details" below. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The documentation was not rendering correctly. It was reusing the
description from one function to many unrelated functions. In addition,
the groups were also rendering incorrectly.
After re-reading the Doxygen documentation it seems that
Is the "Right Thing":tm:
Fixes #8429.
This change is