r261970 - [analyzer] Prune some incorrect \param doc comment annotations.

[Devin Coughlin via cfe-commits]

Author: dcoughlin
Date: Thu Feb 25 21:41:31 2016
New Revision: 261970

URL: http://llvm.org/viewvc/llvm-project?rev=261970&view=rev
Log:
[analyzer] Prune some incorrect \param doc comment annotations.

Modified:
    cfe/trunk/lib/StaticAnalyzer/Checkers/CheckObjCDealloc.cpp
    cfe/trunk/lib/StaticAnalyzer/Checkers/ObjCSuperDeallocChecker.cpp

Modified: cfe/trunk/lib/StaticAnalyzer/Checkers/CheckObjCDealloc.cpp
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/lib/StaticAnalyzer/Checkers/CheckObjCDealloc.cpp?rev=261970&r1=261969&r2=261970&view=diff
==============================================================================
--- cfe/trunk/lib/StaticAnalyzer/Checkers/CheckObjCDealloc.cpp (original)
+++ cfe/trunk/lib/StaticAnalyzer/Checkers/CheckObjCDealloc.cpp Thu Feb 25 21:41:31 2016
@@ -506,7 +506,7 @@ void ObjCDeallocChecker::diagnoseMissing
   assert(!LCtx->inTopFrame() || State->get<UnreleasedIvarMap>().isEmpty());
 }
 
-/// Emits a warning if the current context is -dealloc and \param ReleasedValue
+/// Emits a warning if the current context is -dealloc and ReleasedValue
 /// must not be directly released in a -dealloc. Returns true if a diagnostic
 /// was emitted.
 bool ObjCDeallocChecker::diagnoseExtraRelease(SymbolRef ReleasedValue,
@@ -626,7 +626,7 @@ void ObjCDeallocChecker::initIdentifierI
   ReleaseSel = Ctx.Selectors.getSelector(0, &ReleaseII);
 }
 
-/// Returns true if \param M is a call to '[super dealloc]'.
+/// Returns true if M is a call to '[super dealloc]'.
 bool ObjCDeallocChecker::isSuperDeallocMessage(
     const ObjCMethodCall &M) const {
   if (M.getOriginExpr()->getReceiverKind() != ObjCMessageExpr::SuperInstance)
@@ -642,7 +642,7 @@ ObjCDeallocChecker::getContainingObjCImp
   return cast<ObjCImplDecl>(MD->getDeclContext());
 }
 
-/// Returns the property that shadowed by \param PropImpl if one exists and
+/// Returns the property that shadowed by PropImpl if one exists and
 /// nullptr otherwise.
 const ObjCPropertyDecl *ObjCDeallocChecker::findShadowedPropertyDecl(
     const ObjCPropertyImplDecl *PropImpl) const {
@@ -674,8 +674,8 @@ const ObjCPropertyDecl *ObjCDeallocCheck
   return nullptr;
 }
 
-/// Remove the \param Value requiring a release from the tracked set for
-/// \param Instance and return the resultant state.
+/// Remove the Value requiring a release from the tracked set for
+/// Instance and return the resultant state.
 ProgramStateRef ObjCDeallocChecker::removeValueRequiringRelease(
     ProgramStateRef State, SymbolRef Instance, SymbolRef Value) const {
   assert(Instance);
@@ -729,7 +729,7 @@ ReleaseRequirement ObjCDeallocChecker::g
   llvm_unreachable("Unrecognized setter kind");
 }
 
-/// Returns the released value if \param M is a call to -release. Returns
+/// Returns the released value if M is a call to -release. Returns
 /// nullptr otherwise.
 SymbolRef
 ObjCDeallocChecker::getValueExplicitlyReleased(const ObjCMethodCall &M,
@@ -740,7 +740,7 @@ ObjCDeallocChecker::getValueExplicitlyRe
   return M.getReceiverSVal().getAsSymbol();
 }
 
-/// Returns the released value if \param M is a call a setter that releases
+/// Returns the released value if M is a call a setter that releases
 /// and nils out its underlying instance variable.
 SymbolRef
 ObjCDeallocChecker::getValueReleasedByNillingOut(const ObjCMethodCall &M,
@@ -779,15 +779,15 @@ ObjCDeallocChecker::getValueReleasedByNi
 }
 
 /// Returns true if the current context is a call to -dealloc and false
-/// otherwise. If true, it also sets \param SelfValOut to the value of
+/// otherwise. If true, it also sets SelfValOut to the value of
 /// 'self'.
 bool ObjCDeallocChecker::isInInstanceDealloc(const CheckerContext &C,
                                              SVal &SelfValOut) const {
   return isInInstanceDealloc(C, C.getLocationContext(), SelfValOut);
 }
 
-/// Returns true if \param LCtx is a call to -dealloc and false
-/// otherwise. If true, it also sets \param SelfValOut to the value of
+/// Returns true if LCtx is a call to -dealloc and false
+/// otherwise. If true, it also sets SelfValOut to the value of
 /// 'self'.
 bool ObjCDeallocChecker::isInInstanceDealloc(const CheckerContext &C,
                                              const LocationContext *LCtx,
@@ -805,7 +805,7 @@ bool ObjCDeallocChecker::isInInstanceDea
 }
 
 /// Returns true if there is a call to -dealloc anywhere on the stack and false
-/// otherwise. If true, it also sets \param InstanceValOut to the value of
+/// otherwise. If true, it also sets InstanceValOut to the value of
 /// 'self' in the frame for -dealloc.
 bool ObjCDeallocChecker::instanceDeallocIsOnStack(const CheckerContext &C,
                                                   SVal &InstanceValOut) const {
@@ -821,7 +821,7 @@ bool ObjCDeallocChecker::instanceDealloc
   return false;
 }
 
-/// Returns true if the \param ID is a class in which which is known to have
+/// Returns true if the ID is a class in which which is known to have
 /// a separate teardown lifecycle. In this case, -dealloc warnings
 /// about missing releases should be suppressed.
 bool ObjCDeallocChecker::classHasSeparateTeardown(

Modified: cfe/trunk/lib/StaticAnalyzer/Checkers/ObjCSuperDeallocChecker.cpp
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/lib/StaticAnalyzer/Checkers/ObjCSuperDeallocChecker.cpp?rev=261970&r1=261969&r2=261970&view=diff
==============================================================================
--- cfe/trunk/lib/StaticAnalyzer/Checkers/ObjCSuperDeallocChecker.cpp (original)
+++ cfe/trunk/lib/StaticAnalyzer/Checkers/ObjCSuperDeallocChecker.cpp Thu Feb 25 21:41:31 2016
@@ -173,8 +173,8 @@ void ObjCSuperDeallocChecker::checkLocat
   reportUseAfterDealloc(BaseSym, Desc, S, C);
 }
 
-/// Report a use-after-dealloc on \param Sym. If not empty,
-/// \param Desc will be used to describe the error; otherwise,
+/// Report a use-after-dealloc on Sym. If not empty,
+/// Desc will be used to describe the error; otherwise,
 /// a default warning will be used.
 void ObjCSuperDeallocChecker::reportUseAfterDealloc(SymbolRef Sym,
                                                     StringRef Desc,
@@ -199,7 +199,7 @@ void ObjCSuperDeallocChecker::reportUseA
   C.emitReport(std::move(BR));
 }
 
-/// Diagnose if any of the arguments to \param CE have already been
+/// Diagnose if any of the arguments to CE have already been
 /// dealloc'd.
 void ObjCSuperDeallocChecker::diagnoseCallArguments(const CallEvent &CE,
                                                     CheckerContext &C) const {