From: Dmitri Gribenko <gribozavr@gmail.com>
Date: Fri, 1 Feb 2013 16:36:31 +0000 (+0000)
Subject: libclang: add comments for CXStringFlag
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=17c1a2476aa910760bdb91fe2990c9665eafac9a;p=clang

libclang: add comments for CXStringFlag


git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@174194 91177308-0d34-0410-b5e6-96231b3b80d8
---

diff --git a/tools/libclang/CXString.cpp b/tools/libclang/CXString.cpp
index f2f33a2178..73d1e1e35f 100644
--- a/tools/libclang/CXString.cpp
+++ b/tools/libclang/CXString.cpp
@@ -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.