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/sidebar.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/sidebar.h')
| -rw-r--r-- | ui/sidebar.h | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/ui/sidebar.h b/ui/sidebar.h index ef0b0c0b..79dcb3a8 100644 --- a/ui/sidebar.h +++ b/ui/sidebar.h @@ -13,6 +13,15 @@ class MainWindow; class ContextMenuManager; class SplitPaneWidget; +/*! + + \defgroup sidebar Sidebar + \ingroup uiapi +*/ + +/*! + \ingroup sidebar +*/ struct SidebarIcon { QImage original; @@ -22,6 +31,9 @@ struct SidebarIcon static SidebarIcon generate(const QImage& src); }; +/*! + \ingroup sidebar +*/ class BINARYNINJAUIAPI SidebarWidget : public QWidget { Q_OBJECT @@ -47,6 +59,9 @@ class BINARYNINJAUIAPI SidebarWidget : public QWidget virtual QWidget* headerWidget() { return nullptr; } }; +/*! + \ingroup sidebar +*/ class BINARYNINJAUIAPI SidebarWidgetAndHeader : public QWidget { Q_OBJECT @@ -65,6 +80,9 @@ class BINARYNINJAUIAPI SidebarWidgetAndHeader : public QWidget void updateFonts(); }; +/*! + \ingroup sidebar +*/ class BINARYNINJAUIAPI SidebarHeaderTitle : public QLabel { Q_OBJECT @@ -73,6 +91,9 @@ class BINARYNINJAUIAPI SidebarHeaderTitle : public QLabel SidebarHeaderTitle(const QString& name); }; +/*! + \ingroup sidebar +*/ class BINARYNINJAUIAPI SidebarHeader : public QWidget { Q_OBJECT @@ -81,6 +102,9 @@ class BINARYNINJAUIAPI SidebarHeader : public QWidget SidebarHeader(const QString& name, QWidget* rightSide = nullptr); }; +/*! + \ingroup sidebar +*/ class BINARYNINJAUIAPI SidebarInvalidContextWidget : public SidebarWidget { Q_OBJECT @@ -92,6 +116,9 @@ class BINARYNINJAUIAPI SidebarInvalidContextWidget : public SidebarWidget void openFile(); }; +/*! + \ingroup sidebar +*/ class BINARYNINJAUIAPI SidebarWidgetType { SidebarIcon m_icon; @@ -114,6 +141,9 @@ class BINARYNINJAUIAPI SidebarWidgetType class ViewFrame; +/*! + \ingroup sidebar +*/ struct SidebarWidgetContainerState { SidebarWidgetType* contentWidgetType; @@ -122,6 +152,9 @@ struct SidebarWidgetContainerState QList<int> parentSplitterSizes; }; +/*! + \ingroup sidebar +*/ class BINARYNINJAUIAPI SidebarWidgetContainer : public QWidget { Q_OBJECT @@ -193,6 +226,9 @@ class BINARYNINJAUIAPI SidebarWidgetContainer : public QWidget void hideContents(); }; +/*! + \ingroup sidebar +*/ class BINARYNINJAUIAPI Sidebar : public QWidget { Q_OBJECT |