Improve bootloader documentation.

4 files changed, 28 insertions, 25 deletions

diff --git a/Bootloaders/DFU/BootloaderAPI.h b/Bootloaders/DFU/BootloaderAPI.h
index 2462cacdd..9502bd901 100644
--- a/Bootloaders/DFU/BootloaderAPI.h
+++ b/Bootloaders/DFU/BootloaderAPI.h
@@ -45,6 +45,30 @@
 
 		#include "Config/AppConfig.h"
 
+	/* User Application API: */
+		/** [User Application API] */
+		#define BOOTLOADER_API_TABLE_SIZE          32
+		#define BOOTLOADER_API_TABLE_START         ((FLASHEND + 1UL) - BOOTLOADER_API_TABLE_SIZE)
+		#define BOOTLOADER_API_CALL(Index)         (void*)((BOOTLOADER_API_TABLE_START + (Index * 2)) / 2)
+
+		void    (*BootAPI_ErasePage)(uint32_t Address)               = BOOTLOADER_API_CALL(0);
+		void    (*BootAPI_WritePage)(uint32_t Address)               = BOOTLOADER_API_CALL(1);
+		void    (*BootAPI_FillWord)(uint32_t Address, uint16_t Word) = BOOTLOADER_API_CALL(2);
+		uint8_t (*BootAPI_ReadSignature)(uint16_t Address)           = BOOTLOADER_API_CALL(3);
+		uint8_t (*BootAPI_ReadFuse)(uint16_t Address)                = BOOTLOADER_API_CALL(4);
+		uint8_t (*BootAPI_ReadLock)(void)                            = BOOTLOADER_API_CALL(5);
+		void    (*BootAPI_WriteLock)(uint8_t LockBits)               = BOOTLOADER_API_CALL(6);
+
+		#define BOOTLOADER_MAGIC_SIGNATURE_START   (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 2))
+		#define BOOTLOADER_MAGIC_SIGNATURE         0xDCFB
+
+		#define BOOTLOADER_CLASS_SIGNATURE_START   (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 4))
+		#define BOOTLOADER_CDC_SIGNATURE           0xDF10
+
+		#define BOOTLOADER_ADDRESS_START           (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 8))
+		#define BOOTLOADER_ADDRESS_LENGTH          4
+		/** [User Application API] */
+
 	/* Function Prototypes: */
 		void    BootloaderAPI_ErasePage(const uint32_t Address);
 		void    BootloaderAPI_WritePage(const uint32_t Address);
diff --git a/Bootloaders/DFU/BootloaderAPITable.S b/Bootloaders/DFU/BootloaderAPITable.S
index 101dcbd72..52bd6f8ac 100644
--- a/Bootloaders/DFU/BootloaderAPITable.S
+++ b/Bootloaders/DFU/BootloaderAPITable.S
@@ -87,5 +87,5 @@ BootloaderAPI_JumpTable:
 BootloaderAPI_Signatures:
 
 	.long BOOT_START_ADDR ; Start address of the bootloader
-	.word 0xDF10 ; Signature for the DFU class bootloader, V1
-	.word 0xDCFB ; Signature for a LUFA class bootloader
+	.word 0xDF10          ; Signature for the DFU class bootloader, V1
+	.word 0xDCFB          ; Signature for a LUFA class bootloader
diff --git a/Bootloaders/DFU/BootloaderDFU.txt b/Bootloaders/DFU/BootloaderDFU.txt
index b2540a5b6..801b6dfc6 100644
--- a/Bootloaders/DFU/BootloaderDFU.txt
+++ b/Bootloaders/DFU/BootloaderDFU.txt
@@ -124,28 +124,7 @@
  *  By default, the bootloader API jump table is located 32 bytes from the end of the device's FLASH memory, and follows the
  *  following layout:
  *
- *  \code
- *  #define BOOTLOADER_API_TABLE_SIZE          32
- *  #define BOOTLOADER_API_TABLE_START         ((FLASHEND + 1UL) - BOOTLOADER_API_TABLE_SIZE)
- *  #define BOOTLOADER_API_CALL(Index)         (void*)((BOOTLOADER_API_TABLE_START + (Index * 2)) / 2)
- *
- *  void    (*BootloaderAPI_ErasePage)(uint32_t Address)               = BOOTLOADER_API_CALL(0);
- *  void    (*BootloaderAPI_WritePage)(uint32_t Address)               = BOOTLOADER_API_CALL(1);
- *  void    (*BootloaderAPI_FillWord)(uint32_t Address, uint16_t Word) = BOOTLOADER_API_CALL(2);
- *  uint8_t (*BootloaderAPI_ReadSignature)(uint16_t Address)           = BOOTLOADER_API_CALL(3);
- *  uint8_t (*BootloaderAPI_ReadFuse)(uint16_t Address)                = BOOTLOADER_API_CALL(4);
- *  uint8_t (*BootloaderAPI_ReadLock)(void)                            = BOOTLOADER_API_CALL(5);
- *  void    (*BootloaderAPI_WriteLock)(uint8_t LockBits)               = BOOTLOADER_API_CALL(6);
- *
- *  #define BOOTLOADER_MAGIC_SIGNATURE_START   (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 2))
- *  #define BOOTLOADER_MAGIC_SIGNATURE         0xDCFB
- *
- *  #define BOOTLOADER_CLASS_SIGNATURE_START   (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 4))
- *  #define BOOTLOADER_DFU_SIGNATURE           0xDF10
- *
- *  #define BOOTLOADER_ADDRESS_START           (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 8))
- *  #define BOOTLOADER_ADDRESS_LENGTH          4
- *  \endcode
+ *  \snippet BootloaderAPI.h User Application API
  *
  *  From the application the API support of the bootloader can be detected by reading the FLASH memory bytes located at address
  *  \c BOOTLOADER_MAGIC_SIGNATURE_START and comparing them to the value \c BOOTLOADER_MAGIC_SIGNATURE. The class of bootloader
diff --git a/Bootloaders/DFU/doxyfile b/Bootloaders/DFU/doxyfile
index 6cc42af79..07e331c30 100644
--- a/Bootloaders/DFU/doxyfile
+++ b/Bootloaders/DFU/doxyfile
@@ -834,7 +834,7 @@ EXCLUDE_SYMBOLS        = __* \
 # that contain example code fragments that are included (see the \include
 # command).
 
-EXAMPLE_PATH           =
+EXAMPLE_PATH           = .
 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and