Convert comments to Doxygen style

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@3507 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Chris Lattner
2002-08-25 22:54:55 +00:00
parent 969c4ad65d
commit 2619905926
12 changed files with 366 additions and 359 deletions
+30 -30
View File
@@ -15,9 +15,9 @@
// TerminatorInst Class
//===----------------------------------------------------------------------===//
// TerminatorInst - Subclasses of this class are all able to terminate a basic
// block. Thus, these are all the flow control type of operations.
//
/// TerminatorInst - Subclasses of this class are all able to terminate a basic
/// block. Thus, these are all the flow control type of operations.
///
class TerminatorInst : public Instruction {
protected:
TerminatorInst(Instruction::TermOps iType);
@@ -25,17 +25,17 @@ protected:
const std::string &Name = "");
public:
// Terminators must implement the methods required by Instruction...
/// Terminators must implement the methods required by Instruction...
virtual Instruction *clone() const = 0;
// Additionally, they must provide a method to get at the successors of this
// terminator instruction. 'idx' may not be >= the number of successors
// returned by getNumSuccessors()!
//
/// Additionally, they must provide a method to get at the successors of this
/// terminator instruction. 'idx' may not be >= the number of successors
/// returned by getNumSuccessors()!
///
virtual const BasicBlock *getSuccessor(unsigned idx) const = 0;
virtual unsigned getNumSuccessors() const = 0;
// Set a successor at a given index
/// Set a successor at a given index
virtual void setSuccessor(unsigned idx, BasicBlock *B) = 0;
inline BasicBlock *getSuccessor(unsigned idx) {
@@ -71,29 +71,29 @@ protected:
public:
// create() - Construct a binary instruction, given the opcode
// and the two operands.
//
/// create() - Construct a binary instruction, given the opcode
/// and the two operands.
///
static BinaryOperator *create(BinaryOps Op, Value *S1, Value *S2,
const std::string &Name = "");
// Helper functions to construct and inspect unary operations (NEG and NOT)
// via binary operators SUB and XOR:
//
// createNeg, createNot - Create the NEG and NOT
// instructions out of SUB and XOR instructions.
//
// isNeg, isNot - Check if the given Value is a NEG or NOT instruction.
//
// getNegArgument, getNotArgument - Helper functions to extract the
// unary argument of a NEG or NOT operation implemented via Sub or Xor.
//
/// Helper functions to construct and inspect unary operations (NEG and NOT)
/// via binary operators SUB and XOR:
///
/// createNeg, createNot - Create the NEG and NOT
/// instructions out of SUB and XOR instructions.
///
static BinaryOperator *createNeg(Value *Op, const std::string &Name = "");
static BinaryOperator *createNot(Value *Op, const std::string &Name = "");
/// isNeg, isNot - Check if the given Value is a NEG or NOT instruction.
///
static bool isNeg(const Value *V);
static bool isNot(const Value *V);
/// getNegArgument, getNotArgument - Helper functions to extract the
/// unary argument of a NEG or NOT operation implemented via Sub or Xor.
///
static const Value* getNegArgument(const BinaryOperator* Bop);
static Value* getNegArgument( BinaryOperator* Bop);
static const Value* getNotArgument(const BinaryOperator* Bop);
@@ -107,13 +107,13 @@ public:
return create(getOpcode(), Operands[0], Operands[1]);
}
// swapOperands - Exchange the two operands to this instruction.
// This instruction is safe to use on any binary instruction and
// does not modify the semantics of the instruction. If the
// instruction is order dependant (SetLT f.e.) the opcode is
// changed. If the instruction cannot be reversed (ie, it's a Div),
// then return true.
//
/// swapOperands - Exchange the two operands to this instruction.
/// This instruction is safe to use on any binary instruction and
/// does not modify the semantics of the instruction. If the
/// instruction is order dependant (SetLT f.e.) the opcode is
/// changed. If the instruction cannot be reversed (ie, it's a Div),
/// then return true.
///
bool swapOperands();
// Methods for support type inquiry through isa, cast, and dyn_cast: