summaryrefslogtreecommitdiff
path: root/ui/uicontext.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/uicontext.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/uicontext.h')
-rw-r--r--ui/uicontext.h24
1 files changed, 24 insertions, 0 deletions
diff --git a/ui/uicontext.h b/ui/uicontext.h
index 424411ab..352a62dd 100644
--- a/ui/uicontext.h
+++ b/ui/uicontext.h
@@ -25,8 +25,16 @@ class Pane;
struct SelectionInfoForXref;
/*!
+
+ \defgroup uicontext UIContext
+ \ingroup uiapi
+*/
+
+/*!
Interface used to receive notifications related to files and contexts. Many notifications include the ability
to modify the behavior of the context.
+
+ \ingroup uicontext
*/
class BINARYNINJAUIAPI UIContextNotification
{
@@ -220,6 +228,10 @@ class BINARYNINJAUIAPI UIContextNotification
}
};
+/*!
+
+ \ingroup uicontext
+*/
class BINARYNINJAUIAPI UIContextHandler
{
public:
@@ -229,6 +241,10 @@ class BINARYNINJAUIAPI UIContextHandler
virtual void registerFileOpenMode(const QString& buttonName, const QString& description, const QString& action);
};
+/*!
+
+ \ingroup uicontext
+*/
class BINARYNINJAUIAPI UIContext
{
static UIContextHandler* m_handler;
@@ -453,6 +469,10 @@ class BINARYNINJAUIAPI UIContext
Q_DECLARE_METATYPE(UIContext*)
+/*!
+ @addtogroup uicontext
+ @{
+*/
void BINARYNINJAUIAPI InitUIViews();
void BINARYNINJAUIAPI InitUIActions();
@@ -460,3 +480,7 @@ void BINARYNINJAUIAPI InitUIPlugins();
void BINARYNINJAUIAPI SetCurrentUIPluginLoadOrder(BNPluginLoadOrder order);
void BINARYNINJAUIAPI AddRequiredUIPluginDependency(const std::string& name);
void BINARYNINJAUIAPI AddOptionalUIPluginDependency(const std::string& name);
+
+/*!
+ @}
+*/