aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDmitri Gribenko <gribozavr@gmail.com>2013-02-01 16:38:41 +0000
committerDmitri Gribenko <gribozavr@gmail.com>2013-02-01 16:38:41 +0000
commit15a2aa0954bcf38411c14cf67c65e336022a7a1b (patch)
tree6f96904c4fec41d89348bd64ccc7d7b534fca1b2
parent17c1a2476aa910760bdb91fe2990c9665eafac9a (diff)
libclang: document the purpose of createNull()
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@174195 91177308-0d34-0410-b5e6-96231b3b80d8
-rw-r--r--tools/libclang/CXString.h2
1 files changed, 2 insertions, 0 deletions
diff --git a/tools/libclang/CXString.h b/tools/libclang/CXString.h
index 0495ee9616..06887124fa 100644
--- a/tools/libclang/CXString.h
+++ b/tools/libclang/CXString.h
@@ -29,6 +29,8 @@ struct CXStringBuf;
CXString createEmpty();
/// \brief Create a CXString object for an NULL string.
+///
+/// A NULL string should be used as an "invalid" value in case of errors.
CXString createNull();
/// \brief Create a CXString object from a C string.