diff options
| author | kat <katherine@vector35.com> | 2022-10-23 05:27:30 -0400 |
|---|---|---|
| committer | Peter LaFosse <peter@vector35.com> | 2022-11-10 16:19:13 -0500 |
| commit | 2e74d0a19579c8f5dee38c5b8a7660549746146b (patch) | |
| tree | db478b838d1d02bfce2d0cdac19150e1f42fccfe /ui/stackview.h | |
| parent | ef840b45be92f50fc9e708977efd6b2dcc259ba0 (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/stackview.h')
| -rw-r--r-- | ui/stackview.h | 35 |
1 files changed, 30 insertions, 5 deletions
diff --git a/ui/stackview.h b/ui/stackview.h index 85f6f169..e64b4706 100644 --- a/ui/stackview.h +++ b/ui/stackview.h @@ -12,7 +12,16 @@ #define STACK_VIEW_UPDATE_CHECK_INTERVAL 200 -//! Dialog to enable arbitrary stack variable creation. +/*! + + \defgroup stackview StackView + \ingroup uiapi +*/ + +/*! Dialog to enable arbitrary stack variable creation. + + \ingroup stackview +*/ class BINARYNINJAUIAPI CreateStackVariableDialog : public QDialog { Q_OBJECT @@ -34,7 +43,10 @@ class BINARYNINJAUIAPI CreateStackVariableDialog : public QDialog CreateStackVariableDialog(QWidget* parent, BinaryViewRef data, FunctionRef func, int64_t initialOffset = 0); }; -//! A single line in the stack view. +/*! A single line in the stack view. + + \ingroup stackview +*/ class StackViewLine { public: @@ -142,7 +154,10 @@ class StackViewLine BinaryNinja::DisassemblyTextLine m_content; }; -//! Simple direction enum; used for cursor movement functions. +/*! Simple direction enum; used for cursor movement functions. + + \ingroup stackview +*/ enum class Direction { Up, @@ -151,7 +166,10 @@ enum class Direction Right }; -//! The stack view! +/*! The Stack View + + \ingroup stackview +*/ class BINARYNINJAUIAPI StackView : public QAbstractScrollArea, public View { Q_OBJECT @@ -252,7 +270,10 @@ class BINARYNINJAUIAPI StackView : public QAbstractScrollArea, public View void updateFonts() override; }; -//! Stack view sidebar widget wrapper. +/*! Stack view sidebar widget wrapper. + + \ingroup stackview +*/ class BINARYNINJAUIAPI StackViewSidebarWidget : public SidebarWidget { Q_OBJECT @@ -269,6 +290,10 @@ class BINARYNINJAUIAPI StackViewSidebarWidget : public SidebarWidget QWidget* headerWidget() override { return m_header; } }; +/*! + + \ingroup stackview +*/ class BINARYNINJAUIAPI StackViewSidebarWidgetType : public SidebarWidgetType { public: |