Skip to content

Commit 213d685

Browse files
committed
Add docstring about increment
1 parent 143e4da commit 213d685

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

lldb/bindings/interface/SBProgressDocstrings.i

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,7 @@ without waiting for your language or language implementations non-deterministic
1919
of the SBProgress object.
2020
2121
Note once finalized, no further increments will be processed.") lldb::SBProgress::Finalize;
22+
23+
%feature("docstring",
24+
"Increment the progress by a given number of units, optionally with a message. Not all progress events are guaraunteed
25+
to be sent, but incrementing to the total will always guarauntee a progress end event being sent.") lldb::SBProcess::Increment;

lldb/include/lldb/API/SBProgress.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ class LLDB_API SBProgress {
6161

6262
/// Explicitly finalize an SBProgress, this can be used to terminate a
6363
/// progress on command instead of waiting for a garbage collection or other
64-
/// finalizer.
64+
/// RAII to destroy the contained progress object.
6565
void Finalize();
6666

6767
protected:

0 commit comments

Comments
 (0)