Yay! Dogfooding++ --Sean Silva
On Wed, Aug 22, 2012 at 7:50 PM, Ted Kremenek <[email protected]> wrote: > Author: kremenek > Date: Wed Aug 22 18:50:41 2012 > New Revision: 162412 > > URL: http://llvm.org/viewvc/llvm-project?rev=162412&view=rev > Log: > Fix an assortment of doxygen comment issues found by -Wdocumentation. > > Modified: > cfe/trunk/include/clang/AST/DeclCXX.h > cfe/trunk/include/clang/AST/Expr.h > cfe/trunk/include/clang/AST/ExprObjC.h > cfe/trunk/include/clang/Lex/Preprocessor.h > cfe/trunk/include/clang/StaticAnalyzer/Core/PathSensitive/Store.h > cfe/trunk/lib/Analysis/ThreadSafety.cpp > cfe/trunk/lib/StaticAnalyzer/Core/RegionStore.cpp > > Modified: cfe/trunk/include/clang/AST/DeclCXX.h > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/AST/DeclCXX.h?rev=162412&r1=162411&r2=162412&view=diff > ============================================================================== > --- cfe/trunk/include/clang/AST/DeclCXX.h (original) > +++ cfe/trunk/include/clang/AST/DeclCXX.h Wed Aug 22 18:50:41 2012 > @@ -1303,7 +1303,7 @@ > > /// \brief Function type used by forallBases() as a callback. > /// > - /// \param Base the definition of the base class > + /// \param BaseDefinition the definition of the base class > /// > /// \returns true if this base matched the search criteria > typedef bool ForallBasesCallback(const CXXRecordDecl *BaseDefinition, > > Modified: cfe/trunk/include/clang/AST/Expr.h > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/AST/Expr.h?rev=162412&r1=162411&r2=162412&view=diff > ============================================================================== > --- cfe/trunk/include/clang/AST/Expr.h (original) > +++ cfe/trunk/include/clang/AST/Expr.h Wed Aug 22 18:50:41 2012 > @@ -220,15 +220,6 @@ > /// Reasons why an expression might not be an l-value. > LValueClassification ClassifyLValue(ASTContext &Ctx) const; > > - /// isModifiableLvalue - C99 6.3.2.1: an lvalue that does not have array > type, > - /// does not have an incomplete type, does not have a const-qualified type, > - /// and if it is a structure or union, does not have any member (including, > - /// recursively, any member or element of all contained aggregates or > unions) > - /// with a const-qualified type. > - /// > - /// \param Loc [in,out] - A source location which *may* be filled > - /// in with the location of the expression making this a > - /// non-modifiable lvalue, if specified. > enum isModifiableLvalueResult { > MLV_Valid, > MLV_NotObjectType, > @@ -247,6 +238,15 @@ > MLV_ClassTemporary, > MLV_ArrayTemporary > }; > + /// isModifiableLvalue - C99 6.3.2.1: an lvalue that does not have array > type, > + /// does not have an incomplete type, does not have a const-qualified type, > + /// and if it is a structure or union, does not have any member (including, > + /// recursively, any member or element of all contained aggregates or > unions) > + /// with a const-qualified type. > + /// > + /// \param Loc [in,out] - A source location which *may* be filled > + /// in with the location of the expression making this a > + /// non-modifiable lvalue, if specified. > isModifiableLvalueResult isModifiableLvalue(ASTContext &Ctx, > SourceLocation *Loc = 0) const; > > > Modified: cfe/trunk/include/clang/AST/ExprObjC.h > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/AST/ExprObjC.h?rev=162412&r1=162411&r2=162412&view=diff > ============================================================================== > --- cfe/trunk/include/clang/AST/ExprObjC.h (original) > +++ cfe/trunk/include/clang/AST/ExprObjC.h Wed Aug 22 18:50:41 2012 > @@ -1156,10 +1156,8 @@ > return getReceiverKind() == Class || getReceiverKind() == SuperClass; > } > > - /// \brief Returns the receiver of an instance message. > - /// > - /// \brief Returns the object expression for an instance message, or > - /// NULL for a message that is not an instance message. > + /// \brief Returns the object expression (receiver) for an instance > message, > + /// or null for a message that is not an instance message. > Expr *getInstanceReceiver() { > if (getReceiverKind() == Instance) > return static_cast<Expr *>(getReceiverPointer()); > > Modified: cfe/trunk/include/clang/Lex/Preprocessor.h > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Lex/Preprocessor.h?rev=162412&r1=162411&r2=162412&view=diff > ============================================================================== > --- cfe/trunk/include/clang/Lex/Preprocessor.h (original) > +++ cfe/trunk/include/clang/Lex/Preprocessor.h Wed Aug 22 18:50:41 2012 > @@ -937,7 +937,7 @@ > /// \brief Returns true if the given MacroID location points at the last > /// token of the macro expansion. > /// > - /// \param MacroBegin If non-null and function returns true, it is set to > + /// \param MacroEnd If non-null and function returns true, it is set to > /// end location of the macro. > bool isAtEndOfMacroExpansion(SourceLocation loc, > SourceLocation *MacroEnd = 0) const { > > Modified: cfe/trunk/include/clang/StaticAnalyzer/Core/PathSensitive/Store.h > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/StaticAnalyzer/Core/PathSensitive/Store.h?rev=162412&r1=162411&r2=162412&view=diff > ============================================================================== > --- cfe/trunk/include/clang/StaticAnalyzer/Core/PathSensitive/Store.h > (original) > +++ cfe/trunk/include/clang/StaticAnalyzer/Core/PathSensitive/Store.h Wed Aug > 22 18:50:41 2012 > @@ -69,11 +69,9 @@ > virtual StoreRef BindDefault(Store store, const MemRegion *R, SVal V); > > /// \brief Create a new store with the specified binding removed. > - /// > - /// \brief \param ST the original store, that is the basis for the new > store. > - /// > - /// \brief \param L the location whose binding should be removed. > - virtual StoreRef killBinding(Store St, Loc L) = 0; > + /// \param ST the original store, that is the basis for the new store. > + /// \param L the location whose binding should be removed. > + virtual StoreRef killBinding(Store ST, Loc L) = 0; > > /// \brief Create a new store that binds a value to a compound literal. > /// > > Modified: cfe/trunk/lib/Analysis/ThreadSafety.cpp > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/lib/Analysis/ThreadSafety.cpp?rev=162412&r1=162411&r2=162412&view=diff > ============================================================================== > --- cfe/trunk/lib/Analysis/ThreadSafety.cpp (original) > +++ cfe/trunk/lib/Analysis/ThreadSafety.cpp Wed Aug 22 18:50:41 2012 > @@ -70,27 +70,27 @@ > class SExpr { > private: > enum ExprOp { > - EOP_Nop, //< No-op > - EOP_Wildcard, //< Matches anything. > - EOP_This, //< This keyword. > - EOP_NVar, //< Named variable. > - EOP_LVar, //< Local variable. > - EOP_Dot, //< Field access > - EOP_Call, //< Function call > - EOP_MCall, //< Method call > - EOP_Index, //< Array index > - EOP_Unary, //< Unary operation > - EOP_Binary, //< Binary operation > - EOP_Unknown //< Catchall for everything else > + EOP_Nop, ///< No-op > + EOP_Wildcard, ///< Matches anything. > + EOP_This, ///< This keyword. > + EOP_NVar, ///< Named variable. > + EOP_LVar, ///< Local variable. > + EOP_Dot, ///< Field access > + EOP_Call, ///< Function call > + EOP_MCall, ///< Method call > + EOP_Index, ///< Array index > + EOP_Unary, ///< Unary operation > + EOP_Binary, ///< Binary operation > + EOP_Unknown ///< Catchall for everything else > }; > > > class SExprNode { > private: > - unsigned char Op; //< Opcode of the root node > - unsigned char Flags; //< Additional opcode-specific data > - unsigned short Sz; //< Number of child nodes > - const void* Data; //< Additional opcode-specific data > + unsigned char Op; ///< Opcode of the root node > + unsigned char Flags; ///< Additional opcode-specific data > + unsigned short Sz; ///< Number of child nodes > + const void* Data; ///< Additional opcode-specific data > > public: > SExprNode(ExprOp O, unsigned F, const void* D) > @@ -1385,7 +1385,7 @@ > > > /// \brief Remove a lock from the lockset, warning if the lock is not there. > -/// \param LockExp The lock expression corresponding to the lock to be > removed > +/// \param Mutex The lock expression corresponding to the lock to be removed > /// \param UnlockLoc The source location of the unlock (only used in error > msg) > void ThreadSafetyAnalyzer::removeLock(FactSet &FSet, > const SExpr &Mutex, > @@ -1973,8 +1973,8 @@ > /// are the same. In the event of a difference, we use the intersection of > these > /// two locksets at the start of D. > /// > -/// \param LSet1 The first lockset. > -/// \param LSet2 The second lockset. > +/// \param FSet1 The first lockset. > +/// \param FSet2 The second lockset. > /// \param JoinLoc The location of the join point for error reporting > /// \param LEK1 The error message to report if a mutex is missing from LSet1 > /// \param LEK2 The error message to report if a mutex is missing from Lset2 > > Modified: cfe/trunk/lib/StaticAnalyzer/Core/RegionStore.cpp > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/lib/StaticAnalyzer/Core/RegionStore.cpp?rev=162412&r1=162411&r2=162412&view=diff > ============================================================================== > --- cfe/trunk/lib/StaticAnalyzer/Core/RegionStore.cpp (original) > +++ cfe/trunk/lib/StaticAnalyzer/Core/RegionStore.cpp Wed Aug 22 18:50:41 2012 > @@ -293,11 +293,9 @@ > StoreRef BindAggregate(Store store, const TypedRegion *R, SVal DefaultVal); > > /// \brief Create a new store with the specified binding removed. > - /// > - /// \brief \param ST the original store, that is the basis for the new > store. > - /// > - /// \brief \param L the location whose binding should be removed. > - StoreRef killBinding(Store ST, Loc LV); > + /// \param ST the original store, that is the basis for the new store. > + /// \param L the location whose binding should be removed. > + StoreRef killBinding(Store ST, Loc L); > > void incrementReferenceCount(Store store) { > GetRegionBindings(store).manualRetain(); > > > _______________________________________________ > cfe-commits mailing list > [email protected] > http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits _______________________________________________ cfe-commits mailing list [email protected] http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits
