r174195 - libclang: document the purpose of createNull()

[Dmitri Gribenko]

Author: gribozavr
Date: Fri Feb  1 10:38:41 2013
New Revision: 174195

URL: http://llvm.org/viewvc/llvm-project?rev=174195&view=rev
Log:
libclang: document the purpose of createNull()

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

Modified: cfe/trunk/tools/libclang/CXString.h
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/tools/libclang/CXString.h?rev=174195&r1=174194&r2=174195&view=diff
==============================================================================
--- cfe/trunk/tools/libclang/CXString.h (original)
+++ cfe/trunk/tools/libclang/CXString.h Fri Feb  1 10:38:41 2013
@@ -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.