intel/llvm
1
0
Fork 0
mirror of https://github.com/intel/llvm.git synced 2026-02-07 16:11:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

[lldb][progress][NFC] Clarify Doxygen comments for details field (#86002)

Browse Source 
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.
This commit is contained in:
Chelsea Cassanova
2024-03-21 08:49:43 -07:00
committed by GitHub
parent 38f8a3cf0d
commit 6317c780d8
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
lldb/include/lldb/Core/Progress.h
View File

@@ -66,7 +66,11 @@ public:
/// @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