Skip to content

Commit 6317c78

Browse files
[lldb][progress][NFC] Clarify Doxygen comments for details field (#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.
1 parent 38f8a3c commit 6317c78

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

lldb/include/lldb/Core/Progress.h

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,11 @@ class Progress {
6666
/// @param [in] title The title of this progress activity.
6767
///
6868
/// @param [in] details Specific information about what the progress report
69-
/// is currently working on.
69+
/// is currently working on. Although not required, if the progress report is
70+
/// updated with Progress::Increment() then this field will be overwritten
71+
/// with the new set of details passed into that function, and the details
72+
/// passed initially will act as an "item 0" for the total set of
73+
/// items being reported on.
7074
///
7175
/// @param [in] total The total units of work to be done if specified, if
7276
/// set to std::nullopt then an indeterminate progress indicator should be

0 commit comments

Comments
 (0)