[cfe-commits] r132917 - /cfe/trunk/lib/Sema/SemaDeclObjC.cpp

[Douglas Gregor]

Author: dgregor
Date: Mon Jun 13 11:07:18 2011
New Revision: 132917

URL: http://llvm.org/viewvc/llvm-project?rev=132917&view=rev
Log:
Document CheckObjCMethodOverrides

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

Modified: cfe/trunk/lib/Sema/SemaDeclObjC.cpp
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/lib/Sema/SemaDeclObjC.cpp?rev=132917&r1=132916&r2=132917&view=diff
==============================================================================
--- cfe/trunk/lib/Sema/SemaDeclObjC.cpp (original)
+++ cfe/trunk/lib/Sema/SemaDeclObjC.cpp Mon Jun 13 11:07:18 2011
@@ -73,7 +73,15 @@
   return false;
 }
 
-
+/// \brief Check for consistency between a given method declaration and the
+/// methods it overrides within the class hierarchy.
+///
+/// This method walks the inheritance hierarchy starting at the given 
+/// declaration context (\p DC), invoking Sema::CheckObjCMethodOverride() with
+/// the given new method (\p NewMethod) and any method it directly overrides
+/// in the hierarchy. Sema::CheckObjCMethodOverride() is responsible for
+/// checking consistency, e.g., among return types for methods that return a 
+/// related result type.
 static bool CheckObjCMethodOverrides(Sema &S, ObjCMethodDecl *NewMethod,
                                      DeclContext *DC, 
                                      bool SkipCurrent = true) {