Update doxygen description of a method. NFC

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@303214 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Paul Robinson 2017-05-16 21:53:30 +00:00
parent 25529caa1b
commit 5073f4684a

View File

@ -72,11 +72,14 @@ public:
const DWARFUnit *getUnit() const { return U; }
void dump(raw_ostream &OS) const;
/// \brief extracts a value in data at offset *offset_ptr.
/// Extracts a value in \p Data at offset \p *OffsetPtr.
///
/// The passed DWARFUnit is allowed to be nullptr, in which
/// case no relocation processing will be performed and some
/// kind of forms that depend on Unit information are disallowed.
/// \param Data The DataExtractor to use.
/// \param OffsetPtr The offset within DataExtractor where the data starts.
/// \param U The optional DWARFUnit supplying information for some forms.
/// \returns whether the extraction succeeded.
bool extractValue(const DataExtractor &Data, uint32_t *OffsetPtr,
const DWARFUnit *U);