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/variablelist.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/variablelist.h')
| -rw-r--r-- | ui/variablelist.h | 36 |
1 files changed, 31 insertions, 5 deletions
diff --git a/ui/variablelist.h b/ui/variablelist.h index bbf0a51a..e974f6a3 100644 --- a/ui/variablelist.h +++ b/ui/variablelist.h @@ -10,15 +10,27 @@ #include "uitypes.h" #include "viewframe.h" -//! A variable list item can represent either a function-local variable, or a -//! data variable referenced by the current function. +/*! + + \defgroup variablelist VariableList + \ingroup uiapi +*/ + +/*! A variable list item can represent either a function-local variable, or a + data variable referenced by the current function. + + \ingroup variablelist +*/ enum class VariableListItemType { LocalVariable, DataVariable }; -//! An item part of VariableListModel. +/*! An item part of VariableListModel. + + \ingroup variablelist +*/ class VariableListItem { FunctionRef m_func; @@ -74,7 +86,10 @@ class VariableListItem bool isUserDefined() const; }; -//! The backing model for the variable list widget, holds VariableListItem. +/*! The backing model for the variable list widget, holds VariableListItem. + + \ingroup variablelist +*/ class BINARYNINJAUIAPI VariableListModel : public QAbstractListModel { Q_OBJECT @@ -113,6 +128,10 @@ class BINARYNINJAUIAPI VariableListModel : public QAbstractListModel virtual QVariant headerData(int column, Qt::Orientation orientation, int role) const override; }; +/*! + + \ingroup variablelist +*/ class VariableListItemDelegate : public QStyledItemDelegate { Q_OBJECT @@ -124,7 +143,10 @@ class VariableListItemDelegate : public QStyledItemDelegate QSize sizeHint(const QStyleOptionViewItem& opt, const QModelIndex& index) const; }; -//! The main variable list dock widget. +/*! The main variable list dock widget. + + \ingroup variablelist +*/ class BINARYNINJAUIAPI VariableList : public SidebarWidget { Q_OBJECT @@ -178,6 +200,10 @@ class BINARYNINJAUIAPI VariableList : public SidebarWidget void setSelectedVariableDeadStoreElimination(BNDeadStoreElimination dse); }; +/*! The main variable list dock widget. + + \ingroup variablelist +*/ class BINARYNINJAUIAPI VariableListSidebarWidgetType : public SidebarWidgetType { public: |