summaryrefslogtreecommitdiff
path: root/.doxygen.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 /.doxygen.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 '.doxygen.h')
-rw-r--r--.doxygen.h75
1 files changed, 73 insertions, 2 deletions
diff --git a/.doxygen.h b/.doxygen.h
index 41c95928..7321d4bf 100644
--- a/.doxygen.h
+++ b/.doxygen.h
@@ -19,120 +19,191 @@
*/
+
+/*! The Core set of pure C definitions that the C++ API (and rust/python APIs) wrap.
+
+ The **vast** majority of the time, you should use the clases and utilities provided by the C++, Python, or
+ Rust APIs instead.
+
+ \defgroup core Core
+*/
+
+/*! Classes available to C++ Core Plugins.
+
+ \defgroup coreapi C++ Core API
+*/
+
+/*! Classes available to C++ UI Plugins.
+
+ \defgroup uiapi C++ UI API
+*/
+
/*!
Classes related to interacting with, hooking, and implementing Architectures
\defgroup architectures Architectures
+ \ingroup coreapi
*/
-/*
+/*!
Documentation for interacting with basic blocks
\defgroup basicblocks Basic Blocks
+ \ingroup coreapi
*/
/*!
Classes related to interacting with and implementing custom BinaryViews
\defgroup binaryview BinaryView
+ \ingroup coreapi
*/
/*!
-
\defgroup callingconvention CallingConvention
+ \ingroup coreapi
+*/
+/*!
+ \defgroup confidence Confidence
+ \ingroup coreapi
*/
/*!
\defgroup database Database
+ \ingroup coreapi
*/
/*!
\defgroup databuffer DataBuffer
+ \ingroup coreapi
*/
/*!
\defgroup datarenderer DataRenderer
+ \ingroup coreapi
*/
/*!
\defgroup debuginfo DebugInfo
+ \ingroup coreapi
*/
/*!
\defgroup demangle Demangle
+ \ingroup coreapi
*/
/*!
\defgroup downloadprovider DownloadProvider
+ \ingroup coreapi
*/
/*!
\defgroup fileaccessor FileAccessor
+ \ingroup coreapi
*/
/*!
\defgroup filemetadata FileMetadata
+ \ingroup coreapi
*/
/*!
\defgroup flowgraph Flowgraph
+ \ingroup coreapi
*/
/*!
\defgroup function Function
+ \ingroup coreapi
*/
/*!
\defgroup functionrecognizer FunctionRecognizer
+ \ingroup coreapi
*/
/*!
\defgroup highlevelil High Level IL
+ \ingroup coreapi
*/
/*!
\defgroup interaction Interaction
+ \ingroup coreapi
*/
/*!
\defgroup lineardisassembly LinearDisassembly
+ \ingroup coreapi
*/
/*!
\defgroup logging Logging
+ \ingroup coreapi
*/
/*!
\defgroup lowlevelil Low Level IL
+ \ingroup coreapi
*/
/*!
\defgroup mainthread MainThread
+ \ingroup coreapi
*/
/*!
\defgroup mediumlevelil Medium Level IL
+ \ingroup coreapi
*/
/*!
\defgroup metadata Metadata
+ \ingroup coreapi
*/
/*!
\defgroup platform Platform
+ \ingroup coreapi
*/
/*!
\defgroup plugin Plugin
+ \ingroup coreapi
*/
/*!
\defgroup pluginmanager Plugin Manager
+ \ingroup coreapi
+*/
+/*!
+ \defgroup namelist NameList
+ \ingroup coreapi
+*/
+/*!
+ \defgroup refcount RefCount
+ \ingroup coreapi
*/
/*!
\defgroup scriptingprovider Scripting Provider
+ \ingroup coreapi
*/
/*!
\defgroup secretsprovider Secrets Provider
+ \ingroup coreapi
*/
/*!
\defgroup settings Settings
+ \ingroup coreapi
*/
/*!
\defgroup tempfile TempFile
+ \ingroup coreapi
*/
/*!
\defgroup transform Transform
+ \ingroup coreapi
*/
/*!
\defgroup types Types
+ \ingroup coreapi
*/
/*!
\defgroup typeparser TypeParser
+ \ingroup coreapi
*/
/*!
\defgroup typeprinter TypePrinter
+ \ingroup coreapi
*/
/*!
\defgroup update Update
+ \ingroup coreapi
+*/
+/*!
+ \defgroup undo Undo
+ \ingroup coreapi
*/
/*!
\defgroup websocketprovider Websocket Provider
+ \ingroup coreapi
*/
/*!
\defgroup workflow Workflows
+ \ingroup coreapi
*/
#endif \ No newline at end of file