From fb76fe09297ee292129e44d723127f2408602a3d Mon Sep 17 00:00:00 2001 From: Dan Gohman Date: Mon, 22 Feb 2010 04:10:52 +0000 Subject: Fix various doxygen warnings. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@96779 91177308-0d34-0410-b5e6-96231b3b80d8 --- include/llvm/ADT/StringRef.h | 2 +- include/llvm/CodeGen/Passes.h | 2 +- include/llvm/CodeGen/SelectionDAGISel.h | 4 ++-- include/llvm/Instructions.h | 2 +- include/llvm/MC/MCContext.h | 10 ++++------ include/llvm/MC/MCStreamer.h | 34 ++++++++++++++++----------------- include/llvm/System/Path.h | 2 +- include/llvm/Target/TargetAsmParser.h | 4 ++-- lib/CodeGen/PBQP/HeuristicSolver.h | 4 ++-- lib/Support/FormattedStream.cpp | 2 -- 10 files changed, 31 insertions(+), 35 deletions(-) diff --git a/include/llvm/ADT/StringRef.h b/include/llvm/ADT/StringRef.h index 3064af3abb..61cb558946 100644 --- a/include/llvm/ADT/StringRef.h +++ b/include/llvm/ADT/StringRef.h @@ -355,7 +355,7 @@ namespace llvm { /// \param A - Where to put the substrings. /// \param Separator - The string to split on. /// \param MaxSplit - The maximum number of times the string is split. - /// \parm KeepEmpty - True if empty substring should be added. + /// \param KeepEmpty - True if empty substring should be added. void split(SmallVectorImpl &A, StringRef Separator, int MaxSplit = -1, bool KeepEmpty = true) const; diff --git a/include/llvm/CodeGen/Passes.h b/include/llvm/CodeGen/Passes.h index dbc73cbc54..7c15231b1a 100644 --- a/include/llvm/CodeGen/Passes.h +++ b/include/llvm/CodeGen/Passes.h @@ -187,7 +187,7 @@ namespace llvm { /// createMachineVerifierPass - This pass verifies cenerated machine code /// instructions for correctness. /// - /// @param allowPhysDoubleDefs ignore double definitions of + /// @param allowDoubleDefs ignore double definitions of /// registers. Useful before LiveVariables has run. FunctionPass *createMachineVerifierPass(bool allowDoubleDefs); diff --git a/include/llvm/CodeGen/SelectionDAGISel.h b/include/llvm/CodeGen/SelectionDAGISel.h index f9716142b9..826efacabf 100644 --- a/include/llvm/CodeGen/SelectionDAGISel.h +++ b/include/llvm/CodeGen/SelectionDAGISel.h @@ -122,8 +122,8 @@ protected: return 0; } - /// CheckNodePredicate - This function is generated by tblgen in the - /// target. It runs node predicate #PredNo and returns true if it succeeds or + /// CheckNodePredicate - This function is generated by tblgen in the target. + /// It runs node predicate number PredNo and returns true if it succeeds or /// false if it fails. The number is a private implementation /// detail to the code tblgen produces. virtual bool CheckNodePredicate(SDNode *N, unsigned PredNo) const { diff --git a/include/llvm/Instructions.h b/include/llvm/Instructions.h index d2f7404255..f07291cc62 100644 --- a/include/llvm/Instructions.h +++ b/include/llvm/Instructions.h @@ -1805,7 +1805,7 @@ public: return i/2; } - /// getIncomingBlock - Return incoming basic block #i. + /// getIncomingBlock - Return incoming basic block number @p i. /// BasicBlock *getIncomingBlock(unsigned i) const { return cast(getOperand(i*2+1)); diff --git a/include/llvm/MC/MCContext.h b/include/llvm/MC/MCContext.h index 95c6bd4bb4..74415e2bb0 100644 --- a/include/llvm/MC/MCContext.h +++ b/include/llvm/MC/MCContext.h @@ -46,30 +46,28 @@ namespace llvm { /// @name Symbol Managment /// @{ - /// CreateSymbol - Create a new symbol with the specified @param Name. + /// CreateSymbol - Create a new symbol with the specified @p Name. /// /// @param Name - The symbol name, which must be unique across all symbols. MCSymbol *CreateSymbol(StringRef Name); /// GetOrCreateSymbol - Lookup the symbol inside with the specified - /// @param Name. If it exists, return it. If not, create a forward + /// @p Name. If it exists, return it. If not, create a forward /// reference and return it. /// /// @param Name - The symbol name, which must be unique across all symbols. - /// @param IsTemporary - Whether this symbol is an assembler temporary, - /// which should not survive into the symbol table for the translation unit. MCSymbol *GetOrCreateSymbol(StringRef Name); MCSymbol *GetOrCreateSymbol(const Twine &Name); /// CreateTemporarySymbol - Create a new temporary symbol with the specified - /// @param Name. + /// @p Name. /// /// @param Name - The symbol name, for debugging purposes only, temporary /// symbols do not surive assembly. If non-empty the name must be unique /// across all symbols. MCSymbol *CreateTemporarySymbol(StringRef Name = ""); - /// LookupSymbol - Get the symbol for @param Name, or null. + /// LookupSymbol - Get the symbol for \p Name, or null. MCSymbol *LookupSymbol(StringRef Name) const; /// @} diff --git a/include/llvm/MC/MCStreamer.h b/include/llvm/MC/MCStreamer.h index 624d9a6c06..b104b9ad57 100644 --- a/include/llvm/MC/MCStreamer.h +++ b/include/llvm/MC/MCStreamer.h @@ -92,12 +92,12 @@ namespace llvm { const MCSection *getCurrentSection() const { return CurSection; } /// SwitchSection - Set the current section where code is being emitted to - /// @param Section. This is required to update CurSection. + /// @p Section. This is required to update CurSection. /// /// This corresponds to assembler directives like .section, .text, etc. virtual void SwitchSection(const MCSection *Section) = 0; - /// EmitLabel - Emit a label for @param Symbol into the current section. + /// EmitLabel - Emit a label for @p Symbol into the current section. /// /// This corresponds to an assembler statement such as: /// foo: @@ -107,10 +107,10 @@ namespace llvm { /// used in an assignment. virtual void EmitLabel(MCSymbol *Symbol) = 0; - /// EmitAssemblerFlag - Note in the output the specified @param Flag + /// EmitAssemblerFlag - Note in the output the specified @p Flag virtual void EmitAssemblerFlag(MCAssemblerFlag Flag) = 0; - /// EmitAssignment - Emit an assignment of @param Value to @param Symbol. + /// EmitAssignment - Emit an assignment of @p Value to @p Symbol. /// /// This corresponds to an assembler statement such as: /// symbol = value @@ -123,11 +123,11 @@ namespace llvm { /// @param Value - The value for the symbol. virtual void EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) = 0; - /// EmitSymbolAttribute - Add the given @param Attribute to @param Symbol. + /// EmitSymbolAttribute - Add the given @p Attribute to @p Symbol. virtual void EmitSymbolAttribute(MCSymbol *Symbol, MCSymbolAttr Attribute) = 0; - /// EmitSymbolDesc - Set the @param DescValue for the @param Symbol. + /// EmitSymbolDesc - Set the @p DescValue for the @p Symbol. /// /// @param Symbol - The symbol to have its n_desc field set. /// @param DescValue - The value to set into the n_desc field. @@ -176,8 +176,8 @@ namespace llvm { /// etc. virtual void EmitBytes(StringRef Data, unsigned AddrSpace) = 0; - /// EmitValue - Emit the expression @param Value into the output as a native - /// integer of the given @param Size bytes. + /// EmitValue - Emit the expression @p Value into the output as a native + /// integer of the given @p Size bytes. /// /// This is used to implement assembler directives such as .word, .quad, /// etc. @@ -192,7 +192,7 @@ namespace llvm { /// to pass in a MCExpr for constant integers. virtual void EmitIntValue(uint64_t Value, unsigned Size,unsigned AddrSpace); - /// EmitGPRel32Value - Emit the expression @param Value into the output as a + /// EmitGPRel32Value - Emit the expression @p Value into the output as a /// gprel32 (32-bit GP relative) value. /// /// This is used to implement assembler directives such as .gprel32 on @@ -211,11 +211,11 @@ namespace llvm { } - /// EmitValueToAlignment - Emit some number of copies of @param Value until - /// the byte alignment @param ByteAlignment is reached. + /// EmitValueToAlignment - Emit some number of copies of @p Value until + /// the byte alignment @p ByteAlignment is reached. /// /// If the number of bytes need to emit for the alignment is not a multiple - /// of @param ValueSize, then the contents of the emitted fill bytes is + /// of @p ValueSize, then the contents of the emitted fill bytes is /// undefined. /// /// This used to implement the .align assembler directive. @@ -223,8 +223,8 @@ namespace llvm { /// @param ByteAlignment - The alignment to reach. This must be a power of /// two on some targets. /// @param Value - The value to use when filling bytes. - /// @param Size - The size of the integer (in bytes) to emit for @param - /// Value. This must match a native machine width. + /// @param ValueSize - The size of the integer (in bytes) to emit for + /// @p Value. This must match a native machine width. /// @param MaxBytesToEmit - The maximum numbers of bytes to emit, or 0. If /// the alignment cannot be reached in this many bytes, no bytes are /// emitted. @@ -232,8 +232,8 @@ namespace llvm { unsigned ValueSize = 1, unsigned MaxBytesToEmit = 0) = 0; - /// EmitValueToOffset - Emit some number of copies of @param Value until the - /// byte offset @param Offset is reached. + /// EmitValueToOffset - Emit some number of copies of @p Value until the + /// byte offset @p Offset is reached. /// /// This is used to implement assembler directives such as .org. /// @@ -254,7 +254,7 @@ namespace llvm { /// directive. virtual void EmitDwarfFileDirective(unsigned FileNo,StringRef Filename) = 0; - /// EmitInstruction - Emit the given @param Instruction into the current + /// EmitInstruction - Emit the given @p Instruction into the current /// section. virtual void EmitInstruction(const MCInst &Inst) = 0; diff --git a/include/llvm/System/Path.h b/include/llvm/System/Path.h index 1be27b27be..d4af478c6a 100644 --- a/include/llvm/System/Path.h +++ b/include/llvm/System/Path.h @@ -203,7 +203,7 @@ namespace sys { } /// Makes a copy of \p that to \p this. - /// @param \p that A StringRef denoting the path + /// @param that A StringRef denoting the path /// @returns \p this /// @brief Assignment Operator Path &operator=(StringRef that); diff --git a/include/llvm/Target/TargetAsmParser.h b/include/llvm/Target/TargetAsmParser.h index da9ba2b45b..85315c155d 100644 --- a/include/llvm/Target/TargetAsmParser.h +++ b/include/llvm/Target/TargetAsmParser.h @@ -42,8 +42,8 @@ public: /// line should be parsed up to and including the end-of-statement token. On /// failure, the parser is not required to read to the end of the line. // - /// \param AP - The current parser object. /// \param Name - The instruction name. + /// \param NameLoc - The source location of the name. /// \param Operands [out] - The list of parsed operands, this returns /// ownership of them to the caller. /// \return True on failure. @@ -59,7 +59,7 @@ public: /// the target, the entire line is parsed up to and including the /// end-of-statement token and false is returned. /// - /// \param ID - the identifier token of the directive. + /// \param DirectiveID - the identifier token of the directive. virtual bool ParseDirective(AsmToken DirectiveID) = 0; /// MatchInstruction - Recognize a series of operands of a parsed instruction diff --git a/lib/CodeGen/PBQP/HeuristicSolver.h b/lib/CodeGen/PBQP/HeuristicSolver.h index c156264fae..bd18b5216f 100644 --- a/lib/CodeGen/PBQP/HeuristicSolver.h +++ b/lib/CodeGen/PBQP/HeuristicSolver.h @@ -229,7 +229,7 @@ namespace PBQP { } /// \brief Apply rule R1. - /// @param nItr Node iterator for node to apply R1 to. + /// @param xnItr Node iterator for node to apply R1 to. /// /// Node will be automatically pushed to the solver stack. void applyR1(Graph::NodeItr xnItr) { @@ -277,7 +277,7 @@ namespace PBQP { } /// \brief Apply rule R2. - /// @param nItr Node iterator for node to apply R2 to. + /// @param xnItr Node iterator for node to apply R2 to. /// /// Node will be automatically pushed to the solver stack. void applyR2(Graph::NodeItr xnItr) { diff --git a/lib/Support/FormattedStream.cpp b/lib/Support/FormattedStream.cpp index 39b6cb3f1f..c72b5a1751 100644 --- a/lib/Support/FormattedStream.cpp +++ b/lib/Support/FormattedStream.cpp @@ -56,8 +56,6 @@ void formatted_raw_ostream::ComputeColumn(const char *Ptr, size_t Size) { /// PadToColumn - Align the output to some column number. /// /// \param NewCol - The column to move to. -/// \param MinPad - The minimum space to give after the most recent -/// I/O, even if the current column + minpad > newcol. /// formatted_raw_ostream &formatted_raw_ostream::PadToColumn(unsigned NewCol) { // Figure out what's in the buffer and add it to the column count. -- cgit v1.2.3