improved documentation and README.md

README.md

@@ -1,5 +1,5 @@
-Zyan Disassembler Engine (Zydis)
+Zyan Disassembler Engine (Zydis) [![Build Status](https://travis-ci.org/zyantific/zyan-disassembler-engine.svg?branch=master)](https://travis-ci.org/zyantific/zyan-disassembler-engine)
-==================================
+================================
 
 Fast and lightweight x86/x86-64 disassembler library.
 
@@ -20,7 +20,7 @@ Fast and lightweight x86/x86-64 disassembler library.
 
 The following example program uses Zydis to disassemble a given memory buffer and prints the output to the console.
 
-```C++
+```c++
 #include <tchar.h>
 #include <iostream>
 #include <stdint.h>
@@ -50,5 +50,10 @@ int _tmain(int argc, _TCHAR* argv[])
 
 Zydis builds cleanly on most platforms without any external dependencies. You can use CMake to generate project files for your favorite C++14 compiler.
 
+## Documentation ##
+
+[The HTML Doxygen documentation](https://www.zyantific.com/doc/zydis/index.html) is automatically built from master every 12 hours.
+
 ## License ##
+
 Zyan Disassembler Engine is licensed under the MIT License. Dependencies are under their respective licenses.

Zydis/Zydis.hpp

@@ -28,12 +28,73 @@
 
 ***************************************************************************************************/
 
-#ifndef _ZYDIS_DISASSEMBLER_HPP_
+/**
-#define _ZYDIS_DISASSEMBLER_HPP_
+ * @file
+ * @brief C++ API include file.
+ */
+
+ /**
+  * @mainpage Zyan Disassembler Engine (Zydis)
+  * 
+  * Zydis is a fast and lightweight x86/x86-64 disassembler library.
+  *
+  * @section Features
+  * - Supports all x86 and x86-64 (AMD64) General purpose and System instructions.
+  * - Supported ISA extensions:
+  *  - MMX, FPU (x87), AMD 3DNow
+  *  - SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AES,
+  *  - AMD-V, INTEL-VMX, SMX
+  * - Optimized for high performance
+  * - Very small overhead compared to other common disassembler libraries (about 60KiB)
+  * - Abstract formatter and symbol-resolver classes for custom syntax implementations.
+  *  - Intel syntax is implemented by default
+  * - Complete doxygen documentation
+  *
+  * @section Quick Example
+  * The following example program uses Zydis to disassemble a given memory buffer and prints the 
+  * output to the console.
+  *
+  * @code
+  *     #include <tchar.h>
+  *     #include <iostream>
+  *     #include <stdint.h>
+  *     #include "Zydis.hpp"
+  * 
+  *     int _tmain(int argc, _TCHAR* argv[])
+  *     {
+  *         uint8_t data[] =
+  *         {
+  *             0x90, 0xE9, 0x00, 0x00, 0x00, 0x00, 0xC3
+  *         };
+  *         Zydis::MemoryInput input(&data[0], sizeof(data));
+  *         Zydis::InstructionInfo info;
+  *         Zydis::InstructionDecoder decoder;
+  *         decoder.setDisassemblerMode(Zydis::DisassemblerMode::M32BIT);
+  *         decoder.setDataSource(&input);
+  *         decoder.setInstructionPointer(0);
+  *         Zydis::IntelInstructionFormatter formatter;
+  *         while (decoder.decodeInstruction(info))
+  *         {
+  *             std::cout << formatter.formatInstruction(info) << std::endl;
+  *         }
+  *     }
+  * @endcode
+  *
+  * @section Compilation
+  * Zydis builds cleanly on most platforms without any external dependencies. You can use CMake 
+  * to generate project files for your favorite C++14 compiler.
+  *
+  * @section License
+  * Zyan Disassembler Engine is licensed under the MIT License. Dependencies are under their 
+  * respective licenses.
+  */
+
+#ifndef _ZYDIS_HPP_
+#define _ZYDIS_HPP_
 
 #include "ZydisInstructionDecoder.hpp"
 #include "ZydisInstructionFormatter.hpp"
 #include "ZydisSymbolResolver.hpp"
 #include "ZydisUtils.hpp"
 
-#endif /*_ZYDIS_DISASSEMBLER_HPP_ */
+#endif /*_ZYDIS_HPP_ */

Zydis/ZydisAPI.h

@@ -28,6 +28,11 @@
 
 ***************************************************************************************************/
 
+/**
+ * @file
+ * @brief C API for Zydis.
+ */
+
 #ifndef _ZYDIS_API_H_
 #define _ZYDIS_API_H_
 

Zydis/ZydisInstructionDecoder.hpp

@@ -28,6 +28,11 @@
 
 ***************************************************************************************************/
 
+/**
+ * @file
+ * @brief Instruction decoder classes.
+ */
+
 #ifndef _ZYDIS_INSTRUCTIONDECODER_HPP_
 #define _ZYDIS_INSTRUCTIONDECODER_HPP_
 

Zydis/ZydisInstructionFormatter.hpp

@@ -28,6 +28,11 @@
 
 ***************************************************************************************************/
 
+/**
+ * @file
+ * @brief Instruction formatting classes.
+ */
+
 #ifndef _ZYDIS_INSTRUCTIONFORMATTER_HPP_
 #define _ZYDIS_INSTRUCTIONFORMATTER_HPP_
 

Zydis/ZydisOpcodeTable.hpp

@@ -28,6 +28,11 @@
 
 ***************************************************************************************************/
 
+/**
+ * @file
+ * @brief The opcode table definition, mostly internal stuff.
+ */
+
 #ifndef _ZYDIS_OPCODETABLE_HPP_
 #define _ZYDIS_OPCODETABLE_HPP_
 

Zydis/ZydisSymbolResolver.hpp

@@ -28,6 +28,11 @@
 
 ***************************************************************************************************/
 
+/**
+ * @file
+ * @brief Classes for symbol resolving in the disassembly.
+ */
+
 #ifndef _ZYDIS_SYMBOLRESOLVER_HPP_
 #define _ZYDIS_SYMBOLRESOLVER_HPP_
 

Zydis/ZydisUtils.hpp

@@ -28,6 +28,11 @@
 
 ***************************************************************************************************/
 
+/**
+ * @file
+ * @brief Utility functions.
+ */
+
 #ifndef _ZYDIS_UTILS_HPP_
 #define _ZYDIS_UTILS_HPP_