Skip to content

Commit

Permalink
Add doxygen to RzInterval
Browse files Browse the repository at this point in the history
  • Loading branch information
kazarmy committed Jan 31, 2025
1 parent 55008e4 commit 51ef7eb
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions librz/include/rz_util/rz_itv.h
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,16 @@
extern "C" {
#endif

// An interval in 64-bit address space which is aware of address space wraparound
// Precondition: 0 <= size < 2**64 and addr + size <= 2**64
// range is [], [10, 5) => 10 <= x < (10 + 5)
/**
* \brief An interval in 64-bit address space which is aware of address space wraparound.
*
* Precondition: 0 <= size < 2**64 and addr + size <= 2**64
* Interval range is [addr, addr + size)
* e.g. with addr = 10 and size = 5, interval range is [10, 15) where 10 <= x < (10 + 5).
*/
typedef struct rz_interval_t {
// public:
ut64 addr;
ut64 size;
ut64 addr; ///< Start address of the interval.
ut64 size; ///< Size of the interval in bytes.
} RzInterval;

typedef RzInterval rz_itv_t;
Expand Down

0 comments on commit 51ef7eb

Please sign in to comment.