summaryrefslogtreecommitdiff
path: root/.doxygen.h
diff options
context:
space:
mode:
Diffstat (limited to '.doxygen.h')
-rw-r--r--.doxygen.h138
1 files changed, 138 insertions, 0 deletions
diff --git a/.doxygen.h b/.doxygen.h
new file mode 100644
index 00000000..41c95928
--- /dev/null
+++ b/.doxygen.h
@@ -0,0 +1,138 @@
+#ifdef DOXYGEN_INCLUDE_MAINPAGE
+
+/*
+ This file includes group and page definitions for Doxygen.
+
+ See https://api.binary.ninja/cpp/ & https://dev-api.binary.ninja/cpp/ for built docs,
+ or see binaryninja-api/api-docs/cppdocs/README.md for information on building them yourself.
+
+*/
+
+/*!
+ \mainpage Binary Ninja C++ API
+
+ Welcome to the Binary Ninja C++ API Docs!
+
+ Documentation here has been grouped into several "modules", similar to the python api documentation.
+
+ The "Namespaces" and "Classes" groups can also be used to view a *complete* listing of available classes, structures, and enums.
+
+*/
+
+/*!
+ Classes related to interacting with, hooking, and implementing Architectures
+ \defgroup architectures Architectures
+*/
+/*
+ Documentation for interacting with basic blocks
+ \defgroup basicblocks Basic Blocks
+*/
+/*!
+ Classes related to interacting with and implementing custom BinaryViews
+ \defgroup binaryview BinaryView
+*/
+/*!
+
+ \defgroup callingconvention CallingConvention
+*/
+/*!
+ \defgroup database Database
+*/
+/*!
+ \defgroup databuffer DataBuffer
+*/
+/*!
+ \defgroup datarenderer DataRenderer
+*/
+/*!
+ \defgroup debuginfo DebugInfo
+*/
+/*!
+ \defgroup demangle Demangle
+*/
+/*!
+ \defgroup downloadprovider DownloadProvider
+*/
+/*!
+ \defgroup fileaccessor FileAccessor
+*/
+/*!
+ \defgroup filemetadata FileMetadata
+*/
+/*!
+ \defgroup flowgraph Flowgraph
+*/
+/*!
+ \defgroup function Function
+*/
+/*!
+ \defgroup functionrecognizer FunctionRecognizer
+*/
+/*!
+ \defgroup highlevelil High Level IL
+*/
+/*!
+ \defgroup interaction Interaction
+*/
+/*!
+ \defgroup lineardisassembly LinearDisassembly
+*/
+/*!
+ \defgroup logging Logging
+*/
+/*!
+ \defgroup lowlevelil Low Level IL
+*/
+/*!
+ \defgroup mainthread MainThread
+*/
+/*!
+ \defgroup mediumlevelil Medium Level IL
+*/
+/*!
+ \defgroup metadata Metadata
+*/
+/*!
+ \defgroup platform Platform
+*/
+/*!
+ \defgroup plugin Plugin
+*/
+/*!
+ \defgroup pluginmanager Plugin Manager
+*/
+/*!
+ \defgroup scriptingprovider Scripting Provider
+*/
+/*!
+ \defgroup secretsprovider Secrets Provider
+*/
+/*!
+ \defgroup settings Settings
+*/
+/*!
+ \defgroup tempfile TempFile
+*/
+/*!
+ \defgroup transform Transform
+*/
+/*!
+ \defgroup types Types
+*/
+/*!
+ \defgroup typeparser TypeParser
+*/
+/*!
+ \defgroup typeprinter TypePrinter
+*/
+/*!
+ \defgroup update Update
+*/
+/*!
+ \defgroup websocketprovider Websocket Provider
+*/
+/*!
+ \defgroup workflow Workflows
+*/
+
+#endif \ No newline at end of file