[lldb][progress][NFC] Fix Doxygen information #83502
Merged
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 `details` field in the constructor for `Progress` is missing Doxygen documentation, this commit adds this.
|
@llvm/pr-subscribers-lldb Author: Chelsea Cassanova (chelcassanova) ChangesThe Full diff: https://github.com/llvm/llvm-project/pull/83502.diff 1 Files Affected:
diff --git a/lldb/include/lldb/Core/Progress.h b/lldb/include/lldb/Core/Progress.h
index eb4d9f9d7af08e..9549e3b5aea950 100644
--- a/lldb/include/lldb/Core/Progress.h
+++ b/lldb/include/lldb/Core/Progress.h
@@ -64,6 +64,9 @@ 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.
+ ///
/// @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
/// displayed.
|
JDevlieghere
approved these changes
Mar 1, 2024
bulbazord
approved these changes
Mar 1, 2024
chelcassanova
added a commit
to chelcassanova/llvm-project
that referenced
this pull request
Mar 1, 2024
rdar://122049226 (cherry picked from commit 8171f6d)
chelcassanova
added a commit
to swiftlang/llvm-project
that referenced
this pull request
Mar 2, 2024
rdar://122049226 (cherry picked from commit 8171f6d)
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
detailsfield in the constructor forProgressis missing Doxygen documentation, this commit adds this.