[lldb][progress][NFC] Clarify Doxygen comments for details field
#86002
Conversation
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
The Doxygen comments for the `details` field of a progress report currently does not specify that this field will act as the initial set of details for a progress report that gets updated with `Progress::Increment()`. This commit clarifies this.
|
@llvm/pr-subscribers-lldb Author: Chelsea Cassanova (chelcassanova) ChangesThe Doxygen comments for the Full diff: https://github.com/llvm/llvm-project/pull/86002.diff 1 Files Affected:
diff --git a/lldb/include/lldb/Core/Progress.h b/lldb/include/lldb/Core/Progress.h
index c38f6dd0a140ed..eb3af9816dc6ca 100644
--- a/lldb/include/lldb/Core/Progress.h
+++ b/lldb/include/lldb/Core/Progress.h
@@ -66,7 +66,11 @@ class Progress {
/// @param [in] title The title of this progress activity.
///
/// @param [in] details Specific information about what the progress report
- /// is currently working on.
+ /// is currently working on. Although not required, if the progress report is
+ /// updated with Progress::Increment() then this field will be overwritten
+ /// with the new set of details passed into that function, and the details
+ /// passed initially will act as an "item 0" for the total set of
+ /// items being reported on.
///
/// @param [in] total The total units of work to be done if specified, if
/// set to std::nullopt then an indeterminate progress indicator should be
|
adrian-prantl
approved these changes
Mar 21, 2024
JDevlieghere
approved these changes
Mar 21, 2024
chelcassanova
added a commit
to chelcassanova/llvm-project
that referenced
this pull request
Mar 21, 2024
…lvm#86002) The Doxygen comments for the `details` field of a progress report currently does not specify that this field will act as the initial set of details for a progress report that gets updated with `Progress::Increment()`. This commit clarifies this. (cherry picked from commit 6317c78)
chencha3
pushed a commit
to chencha3/llvm-project
that referenced
this pull request
Mar 23, 2024
…lvm#86002) The Doxygen comments for the `details` field of a progress report currently does not specify that this field will act as the initial set of details for a progress report that gets updated with `Progress::Increment()`. This commit clarifies this.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 Doxygen comments for the
detailsfield of a progress report currently does not specify that this field will act as the initial set of details for a progress report that gets updated withProgress::Increment(). This commit clarifies this.