From 070b1a17dd32a673fd96e645d47dd0ca3bf764c6 Mon Sep 17 00:00:00 2001 From: kat Date: Mon, 17 Oct 2022 12:37:02 -0400 Subject: [C++ docs] Several fixes, improvements, additions, and general cleanup - Sort documentation into groups (aka. modules) - Add DataRenderer, BinaryView, InstructionTextToken, Others docs - Fixes stylesheet for documentation website - New 'Deprecated' section listing deprecated items - Re-add 'Files' listing - Add a 'Main page' and restructure the navbar --- .doxygen.h | 138 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 138 insertions(+) create mode 100644 .doxygen.h (limited to '.doxygen.h') 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 -- cgit v1.3.1