aboutsummaryrefslogtreecommitdiffstats
path: root/include/llvm/Constant.h
diff options
context:
space:
mode:
authorChris Lattner <sabre@nondot.org>2002-08-25 22:54:55 +0000
committerChris Lattner <sabre@nondot.org>2002-08-25 22:54:55 +0000
commit26199059268a05739c84ebf465fcdbf7ded861df (patch)
tree8ec9d990f4bb669601ba3d8264a774e8bdce0392 /include/llvm/Constant.h
parent969c4ad65dd0c23b68117a08eb28f040af379b0d (diff)
downloadexternal_llvm-26199059268a05739c84ebf465fcdbf7ded861df.zip
external_llvm-26199059268a05739c84ebf465fcdbf7ded861df.tar.gz
external_llvm-26199059268a05739c84ebf465fcdbf7ded861df.tar.bz2
Convert comments to Doxygen style
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@3507 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'include/llvm/Constant.h')
-rw-r--r--include/llvm/Constant.h40
1 files changed, 20 insertions, 20 deletions
diff --git a/include/llvm/Constant.h b/include/llvm/Constant.h
index af46dbe..7085738 100644
--- a/include/llvm/Constant.h
+++ b/include/llvm/Constant.h
@@ -16,40 +16,40 @@ protected:
void destroyConstantImpl();
public:
- // Specialize setName to handle symbol table majik...
+ /// setName - Specialize setName to handle symbol table majik...
virtual void setName(const std::string &name, SymbolTable *ST = 0);
- // Static constructor to get a '0' constant of arbitrary type...
+ /// Static constructor to get a '0' constant of arbitrary type...
static Constant *getNullValue(const Type *Ty);
- // isNullValue - Return true if this is the value that would be returned by
- // getNullValue.
+ /// isNullValue - Return true if this is the value that would be returned by
+ /// getNullValue.
virtual bool isNullValue() const = 0;
virtual void print(std::ostream &O) const;
- // isConstantExpr - Return true if this is a ConstantExpr
+ /// isConstantExpr - Return true if this is a ConstantExpr
virtual bool isConstantExpr() const { return false; }
- // destroyConstant - Called if some element of this constant is no longer
- // valid. At this point only other constants may be on the use_list for this
- // constant. Any constants on our Use list must also be destroy'd. The
- // implementation must be sure to remove the constant from the list of
- // available cached constants. Implementations should call
- // destroyConstantImpl as the last thing they do, to destroy all users and
- // delete this.
- //
- // Note that this call is only valid on non-primitive constants: You cannot
- // destroy an integer constant for example. This API is used to delete
- // constants that have ConstantPointerRef's embeded in them when the module is
- // deleted, and it is used by GlobalDCE to remove ConstantPointerRefs that are
- // unneeded, allowing globals to be DCE'd.
- //
+ /// destroyConstant - Called if some element of this constant is no longer
+ /// valid. At this point only other constants may be on the use_list for this
+ /// constant. Any constants on our Use list must also be destroy'd. The
+ /// implementation must be sure to remove the constant from the list of
+ /// available cached constants. Implementations should call
+ /// destroyConstantImpl as the last thing they do, to destroy all users and
+ /// delete this.
+ ///
+ /// Note that this call is only valid on non-primitive constants: You cannot
+ /// destroy an integer constant for example. This API is used to delete
+ /// constants that have ConstantPointerRef's embeded in them when the module
+ /// is deleted, and it is used by GlobalDCE to remove ConstantPointerRefs that
+ /// are unneeded, allowing globals to be DCE'd.
+ ///
virtual void destroyConstant() { assert(0 && "Not reached!"); }
- // Methods for support type inquiry through isa, cast, and dyn_cast:
+ /// Methods for support type inquiry through isa, cast, and dyn_cast:
static inline bool classof(const Constant *) { return true; }
static inline bool classof(const Value *V) {
return V->getValueType() == Value::ConstantVal;