Improve documentation for Sema::CheckReferenceInit

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

diff --git a/lib/Sema/SemaDeclCXX.cpp b/lib/Sema/SemaDeclCXX.cpp
index c5287f6670180ee5203629849ce4bf4c0408c64d..817204c439b494f88e671f36d97eeccc2f041363 100644 (file)
--- a/lib/Sema/SemaDeclCXX.cpp
+++ b/lib/Sema/SemaDeclCXX.cpp
@@ -730,13 +730,13 @@ Sema::CompareReferenceRelationship(QualType T1, QualType T2,
 /// CheckReferenceInit - Check the initialization of a reference
 /// variable with the given initializer (C++ [dcl.init.ref]). Init is
 /// the initializer (either a simple initializer or an initializer
-/// list), and DeclType is the type of the declaration. When Complain
-/// is true, this routine will produce diagnostics (and return true)
-/// when the declaration cannot be initialized with the given
-/// initializer. When ICS is non-null, this routine will compute the
-/// implicit conversion sequence according to C++ [over.ics.ref] and
-/// will not produce any diagnostics; when ICS is null, it will emit
-/// diagnostics when any errors are found.
+/// list), and DeclType is the type of the declaration. When ICS is
+/// non-null, this routine will compute the implicit conversion
+/// sequence according to C++ [over.ics.ref] and will not produce any
+/// diagnostics; when ICS is null, it will emit diagnostics when any
+/// errors are found. Either way, a return value of true indicates
+/// that there was a failure, a return value of false indicates that
+/// the reference initialization succeeded.
 bool 
 Sema::CheckReferenceInit(Expr *&Init, QualType &DeclType, 
                          ImplicitConversionSequence *ICS) {