r174194 - libclang: add comments for CXStringFlag

[Dmitri Gribenko]

Author: gribozavr
Date: Fri Feb  1 10:36:31 2013
New Revision: 174194

URL: http://llvm.org/viewvc/llvm-project?rev=174194&view=rev
Log:
libclang: add comments for CXStringFlag

Modified:
    cfe/trunk/tools/libclang/CXString.cpp

Modified: cfe/trunk/tools/libclang/CXString.cpp
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/tools/libclang/CXString.cpp?rev=174194&r1=174193&r2=174194&view=diff
==============================================================================
--- cfe/trunk/tools/libclang/CXString.cpp (original)
+++ cfe/trunk/tools/libclang/CXString.cpp Fri Feb  1 10:36:31 2013
@@ -23,7 +23,18 @@
 using namespace clang;
 using namespace clang::cxstring;
 
-enum CXStringFlag { CXS_Unmanaged, CXS_Malloc, CXS_StringBuf };
+/// Describes the kind of underlying data in CXString.
+enum CXStringFlag {
+  /// CXString contains a 'const char *' that it doesn't own.
+  CXS_Unmanaged,
+
+  /// CXString contains a 'const char *' that it allocated with malloc().
+  CXS_Malloc,
+
+  /// CXString contains a CXStringBuf that needs to be returned to the
+  /// CXStringPool.
+  CXS_StringBuf
+};
 
 //===----------------------------------------------------------------------===//
 // Basic generation of CXStrings.