diff options
author | Dimitry Andric <dim@FreeBSD.org> | 2019-08-20 20:51:52 +0000 |
---|---|---|
committer | Dimitry Andric <dim@FreeBSD.org> | 2019-08-20 20:51:52 +0000 |
commit | 5f29bb8a675e8f96452b632e7129113f7dec850e (patch) | |
tree | 3d3f2a0d3ad10872a4dcaba8ec8d1d20c87ab147 /include/lldb/Core/DumpDataExtractor.h | |
parent | 88c643b6fec27eec436c8d138fee6346e92337d6 (diff) |
Notes
Diffstat (limited to 'include/lldb/Core/DumpDataExtractor.h')
-rw-r--r-- | include/lldb/Core/DumpDataExtractor.h | 29 |
1 files changed, 13 insertions, 16 deletions
diff --git a/include/lldb/Core/DumpDataExtractor.h b/include/lldb/Core/DumpDataExtractor.h index 88446d48fa646..2a9d778e0a6a8 100644 --- a/include/lldb/Core/DumpDataExtractor.h +++ b/include/lldb/Core/DumpDataExtractor.h @@ -1,9 +1,8 @@ //===-- DumpDataExtractor.h -------------------------------------*- C++ -*-===// // -// The LLVM Compiler Infrastructure -// -// This file is distributed under the University of Illinois Open Source -// License. See LICENSE.TXT for details. +// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. +// See https://llvm.org/LICENSE.txt for license information. +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception // //===----------------------------------------------------------------------===// @@ -21,7 +20,6 @@ class DataExtractor; class ExecutionContextScope; class Stream; -//------------------------------------------------------------------ /// Dumps \a item_count objects into the stream \a s. /// /// Dumps \a item_count objects using \a item_format, each of which @@ -35,31 +33,31 @@ class Stream; /// same start offset, format and size, yet differing \a /// item_bit_size and \a item_bit_offset values. /// -/// @param[in] s +/// \param[in] s /// The stream to dump the output to. This value can not be nullptr. /// -/// @param[in] offset +/// \param[in] offset /// The offset into the data at which to start dumping. /// -/// @param[in] item_format +/// \param[in] item_format /// The format to use when dumping each item. /// -/// @param[in] item_byte_size +/// \param[in] item_byte_size /// The byte size of each item. /// -/// @param[in] item_count +/// \param[in] item_count /// The number of items to dump. /// -/// @param[in] num_per_line +/// \param[in] num_per_line /// The number of items to display on each line. /// -/// @param[in] base_addr +/// \param[in] base_addr /// The base address that gets added to the offset displayed on /// each line if the value is valid. Is \a base_addr is /// LLDB_INVALID_ADDRESS then no address values will be prepended /// to any lines. /// -/// @param[in] item_bit_size +/// \param[in] item_bit_size /// If the value to display is a bitfield, this value should /// be the number of bits that the bitfield item has within the /// item's byte size value. This function will need to be called @@ -68,7 +66,7 @@ class Stream; /// exist within the same integer value. If the items being /// displayed are not bitfields, this value should be zero. /// -/// @param[in] item_bit_offset +/// \param[in] item_bit_offset /// If the value to display is a bitfield, this value should /// be the offset in bits, or shift right amount, that the /// bitfield item occupies within the item's byte size value. @@ -78,9 +76,8 @@ class Stream; /// same integer value. If the items being displayed are not /// bitfields, this value should be zero. /// -/// @return +/// \return /// The offset at which dumping ended. -//------------------------------------------------------------------ lldb::offset_t DumpDataExtractor(const DataExtractor &DE, Stream *s, lldb::offset_t offset, lldb::Format item_format, size_t item_byte_size, |