diff options
Diffstat (limited to 'include/lldb/Utility/DataExtractor.h')
| -rw-r--r-- | include/lldb/Utility/DataExtractor.h | 34 |
1 files changed, 13 insertions, 21 deletions
diff --git a/include/lldb/Utility/DataExtractor.h b/include/lldb/Utility/DataExtractor.h index 4ef78c1af492..8107a3554422 100644 --- a/include/lldb/Utility/DataExtractor.h +++ b/include/lldb/Utility/DataExtractor.h @@ -513,10 +513,8 @@ public: /// /// Extract a single integer value and update the offset pointed to /// by \a offset_ptr. The size of the extracted integer is specified - /// by the \a byte_size argument. \a byte_size should have a value - /// >= 1 and <= 4 since the return value is only 32 bits wide. Any - /// \a byte_size values less than 1 or greater than 4 will result in - /// nothing being extracted, and zero being returned. + /// by the \a byte_size argument. \a byte_size must have a value + /// >= 1 and <= 4 since the return value is only 32 bits wide. /// /// @param[in,out] offset_ptr /// A pointer to an offset within the data that will be advanced @@ -539,11 +537,9 @@ public: /// /// Extract a single unsigned integer value and update the offset /// pointed to by \a offset_ptr. The size of the extracted integer - /// is specified by the \a byte_size argument. \a byte_size should + /// is specified by the \a byte_size argument. \a byte_size must /// have a value greater than or equal to one and less than or equal - /// to eight since the return value is 64 bits wide. Any - /// \a byte_size values less than 1 or greater than 8 will result in - /// nothing being extracted, and zero being returned. + /// to eight since the return value is 64 bits wide. /// /// @param[in,out] offset_ptr /// A pointer to an offset within the data that will be advanced @@ -570,10 +566,9 @@ public: /// Extract a single signed integer value (sign extending if required) /// and update the offset pointed to by \a offset_ptr. The size of /// the extracted integer is specified by the \a byte_size argument. - /// \a byte_size should have a value greater than or equal to one - /// and less than or equal to eight since the return value is 64 - /// bits wide. Any \a byte_size values less than 1 or greater than - /// 8 will result in nothing being extracted, and zero being returned. + /// \a byte_size must have a value greater than or equal to one and + /// less than or equal to eight since the return value is 64 bits + /// wide. /// /// @param[in,out] offset_ptr /// A pointer to an offset within the data that will be advanced @@ -589,7 +584,7 @@ public: /// The sign extended signed integer value that was extracted, /// or zero on failure. //------------------------------------------------------------------ - int64_t GetMaxS64(lldb::offset_t *offset_ptr, size_t size) const; + int64_t GetMaxS64(lldb::offset_t *offset_ptr, size_t byte_size) const; //------------------------------------------------------------------ /// Extract an unsigned integer of size \a byte_size from \a @@ -598,11 +593,9 @@ public: /// /// Extract a single unsigned integer value and update the offset /// pointed to by \a offset_ptr. The size of the extracted integer - /// is specified by the \a byte_size argument. \a byte_size should + /// is specified by the \a byte_size argument. \a byte_size must /// have a value greater than or equal to one and less than or equal - /// to 8 since the return value is 64 bits wide. Any - /// \a byte_size values less than 1 or greater than 8 will result in - /// nothing being extracted, and zero being returned. + /// to 8 since the return value is 64 bits wide. /// /// @param[in,out] offset_ptr /// A pointer to an offset within the data that will be advanced @@ -641,10 +634,9 @@ public: /// Extract a single signed integer value (sign extending if required) /// and update the offset pointed to by \a offset_ptr. The size of /// the extracted integer is specified by the \a byte_size argument. - /// \a byte_size should have a value greater than or equal to one - /// and less than or equal to eight since the return value is 64 - /// bits wide. Any \a byte_size values less than 1 or greater than - /// 8 will result in nothing being extracted, and zero being returned. + /// \a byte_size must have a value greater than or equal to one and + /// less than or equal to eight since the return value is 64 bits + /// wide. /// /// @param[in,out] offset_ptr /// A pointer to an offset within the data that will be advanced |