Skip to content

Commit

Permalink
Update doxygen description of a method. NFC
Browse files Browse the repository at this point in the history
llvm-svn: 303214
  • Loading branch information
pogo59 committed May 16, 2017
1 parent 877364f commit 4dc5a1e
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion llvm/include/llvm/DebugInfo/DWARF/DWARFFormValue.h
Original file line number Diff line number Diff line change
Expand Up @@ -72,11 +72,14 @@ class DWARFFormValue {
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);
Expand Down

0 comments on commit 4dc5a1e

Please sign in to comment.