From: Dmitri Gribenko <gribozavr@gmail.com>
Date: Fri, 1 Feb 2013 16:38:41 +0000 (+0000)
Subject: libclang: document the purpose of createNull()
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=15a2aa0954bcf38411c14cf67c65e336022a7a1b;p=clang

libclang: document the purpose of createNull()


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

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.