summaryrefslogtreecommitdiff
path: root/include/llvm/Support/Casting.h
diff options
context:
space:
mode:
authorChris Lattner <sabre@nondot.org>2011-04-09 02:33:29 +0000
committerChris Lattner <sabre@nondot.org>2011-04-09 02:33:29 +0000
commit5fc25cccff3cdbfd34d08b9c1233f9af1879018c (patch)
tree1016936fac20d9edc1e712f3868a64697d35f7b0 /include/llvm/Support/Casting.h
parentb3452ea35c3e78d1a8c7d92f9448b0054d36e740 (diff)
downloadllvm-5fc25cccff3cdbfd34d08b9c1233f9af1879018c.tar.gz
llvm-5fc25cccff3cdbfd34d08b9c1233f9af1879018c.tar.bz2
llvm-5fc25cccff3cdbfd34d08b9c1233f9af1879018c.tar.xz
fix doc comment bug, noticed by Jochen
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@129186 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'include/llvm/Support/Casting.h')
-rw-r--r--include/llvm/Support/Casting.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/include/llvm/Support/Casting.h b/include/llvm/Support/Casting.h
index 6bb9806438..abb5a9aa11 100644
--- a/include/llvm/Support/Casting.h
+++ b/include/llvm/Support/Casting.h
@@ -192,8 +192,8 @@ template<class To, class FromTy> struct cast_convert_val<To,FromTy,FromTy> {
// cast<X> - Return the argument parameter cast to the specified type. This
// casting operator asserts that the type is correct, so it does not return null
-// on failure. But it will correctly return NULL when the input is NULL.
-// Used Like this:
+// on failure. It does not allow a null argument (use cast_or_null for that).
+// It is typically used like this:
//
// cast<Instruction>(myVal)->getParent()
//