Skip to content

Commit 49c22e3

Browse files
committed
Thread Safety Analysis: Improve comments of LockErrorKind
Move documentation inline and add missing documentation for LEK_NotLockedAtEndOfFunction. NFC. Factored out from: #137133
1 parent 4d9479f commit 49c22e3

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

clang/include/clang/Analysis/Analyses/ThreadSafety.h

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -94,16 +94,14 @@ enum AccessKind {
9494

9595
/// This enum distinguishes between different situations where we warn due to
9696
/// inconsistent locking.
97-
/// \enum SK_LockedSomeLoopIterations -- a mutex is locked for some but not all
98-
/// loop iterations.
99-
/// \enum SK_LockedSomePredecessors -- a mutex is locked in some but not all
100-
/// predecessors of a CFGBlock.
101-
/// \enum SK_LockedAtEndOfFunction -- a mutex is still locked at the end of a
102-
/// function.
10397
enum LockErrorKind {
98+
/// A capability is locked for some but not all loop iterations.
10499
LEK_LockedSomeLoopIterations,
100+
/// A capability is locked in some but not all predecessors of a CFGBlock.
105101
LEK_LockedSomePredecessors,
102+
/// A capability is still locked at the end of a function.
106103
LEK_LockedAtEndOfFunction,
104+
/// Expecting a capability to be held at the end of function.
107105
LEK_NotLockedAtEndOfFunction
108106
};
109107

0 commit comments

Comments
 (0)