[cfe-commits] r58404 - /cfe/trunk/lib/Sema/SemaDeclCXX.cpp

[Douglas Gregor]

Author: dgregor
Date: Wed Oct 29 18:31:03 2008
New Revision: 58404

URL: http://llvm.org/viewvc/llvm-project?rev=58404&view=rev
Log:
Improve documentation for Sema::CheckReferenceInit

Modified:
    cfe/trunk/lib/Sema/SemaDeclCXX.cpp

Modified: cfe/trunk/lib/Sema/SemaDeclCXX.cpp
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/lib/Sema/SemaDeclCXX.cpp?rev=58404&r1=58403&r2=58404&view=diff

==============================================================================
--- cfe/trunk/lib/Sema/SemaDeclCXX.cpp (original)
+++ cfe/trunk/lib/Sema/SemaDeclCXX.cpp Wed Oct 29 18:31:03 2008
@@ -730,13 +730,13 @@
 /// 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) {