summaryrefslogtreecommitdiff
path: root/ui/addressindicator.h
diff options
context:
space:
mode:
authorkat <katherine@vector35.com>2022-10-23 05:27:30 -0400
committerPeter LaFosse <peter@vector35.com>2022-11-10 16:19:13 -0500
commit2e74d0a19579c8f5dee38c5b8a7660549746146b (patch)
treedb478b838d1d02bfce2d0cdac19150e1f42fccfe /ui/addressindicator.h
parentef840b45be92f50fc9e708977efd6b2dcc259ba0 (diff)
Several documentation improvements and fixes
- Reduce file count, add minifier script - Group UI and group Core C - Add more items to groups - Add Tranform docs
Diffstat (limited to 'ui/addressindicator.h')
-rw-r--r--ui/addressindicator.h25
1 files changed, 22 insertions, 3 deletions
diff --git a/ui/addressindicator.h b/ui/addressindicator.h
index 76d3eefa..fce16a11 100644
--- a/ui/addressindicator.h
+++ b/ui/addressindicator.h
@@ -5,7 +5,16 @@
#include "menus.h"
#include "uicontext.h"
-//! Format for displaying offsets.
+/*!
+
+ \defgroup addressindicator AddressIndicator
+ \ingroup uiapi
+*/
+
+/*! Format for displaying offsets
+
+ \ingroup addressindicator
+*/
enum class OffsetFormat : char
{
VirtualAddress,
@@ -15,7 +24,10 @@ enum class OffsetFormat : char
FunctionStart
};
-//! Format for displaying an address range.
+/*! Format for displaying an address range
+
+ \ingroup addressindicator
+*/
enum class RangeFormat : char
{
StartOnly,
@@ -24,13 +36,20 @@ enum class RangeFormat : char
StartAndEnd
};
-//! Options for displaying an address or address range.
+/*! Options for displaying an address or address range
+
+ \ingroup addressindicator
+*/
struct DisplayOptions
{
OffsetFormat format = OffsetFormat::VirtualAddress;
RangeFormat rangeFormat = RangeFormat::StartAndEnd;
};
+/*!
+
+ \ingroup addressindicator
+*/
class BINARYNINJAUIAPI AddressIndicator : public MenuHelper
{
Q_OBJECT