Update doxygen description of a method. NFC
authorPaul Robinson <paul.robinson@sony.com>
Tue, 16 May 2017 21:53:30 +0000 (21:53 +0000)
committerPaul Robinson <paul.robinson@sony.com>
Tue, 16 May 2017 21:53:30 +0000 (21:53 +0000)
llvm-svn: 303214

llvm/include/llvm/DebugInfo/DWARF/DWARFFormValue.h

index f3516eb..df2d0da 100644 (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);