Add comments for two CleanupKinds.
authorNico Weber <nicolasweber@gmx.de>
Wed, 25 Feb 2015 03:58:36 +0000 (03:58 +0000)
committerNico Weber <nicolasweber@gmx.de>
Wed, 25 Feb 2015 03:58:36 +0000 (03:58 +0000)
llvm-svn: 230459

clang/lib/CodeGen/EHScopeStack.h

index 3619b50..6535b76 100644 (file)
@@ -75,8 +75,14 @@ template <class T> struct DominatingPointer<T,false> : InvariantValue<T*> {};
 template <class T> struct DominatingValue<T*> : DominatingPointer<T> {};
 
 enum CleanupKind : unsigned {
+  /// Denotes a cleanup that should run when a scope is exited using exceptional
+  /// control flow (a throw statement leading to stack unwinding, ).
   EHCleanup = 0x1,
+
+  /// Denotes a cleanup that should run when a scope is exited using normal
+  /// control flow (falling off the end of the scope, return, goto, ...).
   NormalCleanup = 0x2,
+
   NormalAndEHCleanup = EHCleanup | NormalCleanup,
 
   InactiveCleanup = 0x4,