Clean up the doxygen formatting of the comments on the strip* methods on

Value. These methods probably don't belong here, and I'm discussing
moving the lot of them to a better home, but for now I'm about to extend
their functionality and wanted to tidy them up first.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@188997 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Chandler Carruth 2013-08-22 10:12:18 +00:00
parent f7ab3a84b3
commit f6db942564

View File

@ -260,37 +260,37 @@ public:
/// this value. /// this value.
bool hasValueHandle() const { return HasValueHandle; } bool hasValueHandle() const { return HasValueHandle; }
/// \brief This method strips off any unneeded pointer casts, /// \brief Strips off any unneeded pointer casts, all-zero GEPs and aliases
/// all-zero GEPs and aliases from the specified value, returning the original /// from the specified value, returning the original uncasted value.
/// uncasted value. If this is called on a non-pointer value, it returns ///
/// 'this'. /// If this is called on a non-pointer value, it returns 'this'.
Value *stripPointerCasts(); Value *stripPointerCasts();
const Value *stripPointerCasts() const { const Value *stripPointerCasts() const {
return const_cast<Value*>(this)->stripPointerCasts(); return const_cast<Value*>(this)->stripPointerCasts();
} }
/// \brief This method strips off any unneeded pointer casts and /// \brief Strips off any unneeded pointer casts and all-zero GEPs from the
/// all-zero GEPs from the specified value, returning the original /// specified value, returning the original uncasted value.
/// uncasted value. If this is called on a non-pointer value, it returns ///
/// 'this'. /// If this is called on a non-pointer value, it returns 'this'.
Value *stripPointerCastsNoFollowAliases(); Value *stripPointerCastsNoFollowAliases();
const Value *stripPointerCastsNoFollowAliases() const { const Value *stripPointerCastsNoFollowAliases() const {
return const_cast<Value*>(this)->stripPointerCastsNoFollowAliases(); return const_cast<Value*>(this)->stripPointerCastsNoFollowAliases();
} }
/// stripInBoundsConstantOffsets - This method strips off unneeded pointer casts and /// \brief Strips off unneeded pointer casts and all-constant GEPs from the
/// all-constant GEPs from the specified value, returning the original /// specified value, returning the original pointer value.
/// pointer value. If this is called on a non-pointer value, it returns ///
/// 'this'. /// If this is called on a non-pointer value, it returns 'this'.
Value *stripInBoundsConstantOffsets(); Value *stripInBoundsConstantOffsets();
const Value *stripInBoundsConstantOffsets() const { const Value *stripInBoundsConstantOffsets() const {
return const_cast<Value*>(this)->stripInBoundsConstantOffsets(); return const_cast<Value*>(this)->stripInBoundsConstantOffsets();
} }
/// stripInBoundsOffsets - This method strips off unneeded pointer casts and /// \brief Strips off unneeded pointer casts and any in-bounds offsets from
/// any in-bounds Offsets from the specified value, returning the original /// the specified value, returning the original pointer value.
/// pointer value. If this is called on a non-pointer value, it returns ///
/// 'this'. /// If this is called on a non-pointer value, it returns 'this'.
Value *stripInBoundsOffsets(); Value *stripInBoundsOffsets();
const Value *stripInBoundsOffsets() const { const Value *stripInBoundsOffsets() const {
return const_cast<Value*>(this)->stripInBoundsOffsets(); return const_cast<Value*>(this)->stripInBoundsOffsets();