[docs] Improve doxypress documentation

Author: salkinium

.gitignore

@@ -31,6 +31,7 @@ CMakeLists.txt
 
 # ignore generated code in the example folder
 examples/**/modm
+examples/**/modm-test
 examples/**/artifacts
 examples/**/compile_commands.json
 examples/**/SConstruct

src/modm/architecture/detect.hpp

@@ -16,76 +16,81 @@
 
 #ifdef __DOXYGEN__
 
-
-/// Compiler description
 /// @ingroup modm_architecture
+/// @{
+
+/// Compiler description string
 #define	MODM_COMPILER_STRING
 
-/// Possible compilers
-/// @ingroup modm_architecture
-/// @{
+/// Compiling with GCC
 #define	MODM_COMPILER_GCC
-#define	MODM_COMPILER_MSVC
-/// @}
+/// Compiling with GCC on Windows
+#define MODM_COMPILER_MINGW
 
-/// Operating system description
-/// @ingroup modm_architecture
+/// Operating system description string
 #define	MODM_OS_STRING
 
-/// Possible operating systems
-/// @ingroup modm_architecture
-/// @{
+/// Compiling for a UNIX target
 #define	MODM_OS_UNIX
+/// Compiling for a Linux target
 #define	MODM_OS_LINUX
+/// Compiling for a macOS target
 #define	MODM_OS_OSX
+/// Compiling for a Windows 32-bit target
 #define	MODM_OS_WIN32
+/// Compiling for a Windows 64-bit target
 #define	MODM_OS_WIN64
+/// Compiling for a hosted (non-barebone) target
 #define	MODM_OS_HOSTED
-#define	MODM_OS_HOSTED_64
-/// @}
+/// Compiling for a barebone target without OS
+#define MODM_OS_NONE
 
-/// CPU description
-/// @ingroup modm_architecture
+/// CPU description string
 #define	MODM_CPU_STRING
 
-/// Possible CPU definitions
-/// @ingroup modm_architecture
-/// @{
+/// Compiling for x86-64 target
+#define MODM_CPU_AMD64
+/// Compiling for x86 target
+#define MODM_CPU_I386
+
+/// Compiling for AVR target
 #define	MODM_CPU_AVR
-#define	MODM_CPU_ATXMEGA
+/// Compiling for AVR ATmega target
 #define	MODM_CPU_ATMEGA
+/// Compiling for AVR ATtiny target
 #define	MODM_CPU_ATTINY
 
+/// Compiling for ARM target
 #define	MODM_CPU_ARM
-#define	MODM_CPU_ARM7TDMI
+/// Compiling for ARM Cortex-M0 or Cortex-M0+ target
 #define	MODM_CPU_CORTEX_M0
+/// Compiling for ARM Cortex-M3 target
 #define	MODM_CPU_CORTEX_M3
+/// Compiling for ARM Cortex-M4 or Cortex-M7 target
 #define	MODM_CPU_CORTEX_M4
-/// @}
+/// Compiling for ARM Cortex-M33 target
+#define MODM_CPU_CORTEX_M33
+/// Compiling for ARM AArch64 target
+#define MODM_CPU_AARCH64
 
-///	Memory descriptions
-/// @ingroup modm_architecture
-/// @{
+/// Native memory alignment in bytes
 #define MODM_ALIGNMENT
 
-#define MODM_ORDER_BIG_ENDIAN
-#define MODM_ORDER_LITTLE_ENDIAN
-#define MODM_ORDER_PDP_ENDIAN
-
-#define MODM_BYTE_ORDER
-
-#define MODM_IS_BIG_ENDIAN
+/// Compiling for a little endian memory layout
 #define MODM_IS_LITTLE_ENDIAN
+/// Compiling for a big endian memory layout
+#define MODM_IS_BIG_ENDIAN
 
+/// Size of pointer in bytes
 #define	MODM_SIZEOF_POINTER
+
 /// @}
 
-#else //!__DOXYGEN__
+#else // !__DOXYGEN__
 
-// ----------------------------------------------------------------------------
-// Determine compilation environment
-
-/**
+/* ----------------------------------------------------------------------------
+ * Determine compilation environment
+ *
  * This relies on the predefined defines of the compiler.
  * To display the defines run:
  * $your-gcc-compiler -dM -E - < /dev/null | sort | less
@@ -99,83 +104,74 @@
  * $arm-none-eabi-g++ -dM -E -mcpu=cortex-m0 -mthumb -D__ARM_LPC1114_301__ -D__ARM_LPC11XX__ - < /dev/null
  */
 
-#if defined __clang__
+#ifdef __clang__
 #	define MODM_COMPILER_STRING	"Clang"
-#	define MODM_COMPILER_CLANG 1
+#	define MODM_COMPILER_CLANG	1
 #elif defined __GNUC__
-#	define MODM_COMPILER_GCC 1
-#	if defined __MINGW32__
+#	define MODM_COMPILER_GCC	1
+#	ifdef __MINGW32__
 #		define MODM_COMPILER_STRING	"MinGW / MinGW-w64"
-#		define MODM_COMPILER_MINGW 1
+#		define MODM_COMPILER_MINGW	1
 #	else
 #		define MODM_COMPILER_STRING	"Gnu GCC"
 #	endif
 #endif
 
-#if defined _MSC_VER
-#	define MODM_COMPILER_STRING 	"Microsoft Visual C++"
-#	define MODM_COMPILER_MSVC 1
-#endif
-
-#if !defined MODM_COMPILER_STRING
-#	define MODM_COMPILER_STRING 	"Unknown compiler"
+#ifndef MODM_COMPILER_STRING
+#	define MODM_COMPILER_STRING		"Unknown compiler"
 #	warning	"Couldn't determine the used compiler! Please add it to <modm/architecture/detect.hpp>"
 #endif
 
 // ----------------------------------------------------------------------------
 // Determine target operating system
 
 #if defined linux || defined __linux__
-#	define MODM_OS_HOSTED 1
-#	define MODM_OS_LINUX 1
-#	define MODM_OS_STRING 			"Linux"
+#	define MODM_OS_HOSTED	1
+#	define MODM_OS_LINUX	1
+#	define MODM_OS_STRING 	"Linux"
 #endif
 
 #if (defined __MWERKS__ && defined __powerc && !defined macintosh) || defined __APPLE_CC__ || defined macosx
-#	define MODM_OS_HOSTED 1
-#	define MODM_OS_OSX 1
-#	define MODM_OS_STRING			"MacOS X"
+#	define MODM_OS_HOSTED	1
+#	define MODM_OS_OSX		1
+#	define MODM_OS_STRING	"MacOS X"
 #endif
 
-#if defined __unix__
-#	define MODM_OS_HOSTED 1
-#	define MODM_OS_UNIX 1
-#	if !defined MODM_OS_STRING
-#		define MODM_OS_STRING 		"Unix-like(generic)"
+#ifdef __unix__
+#	define MODM_OS_HOSTED	1
+#	define MODM_OS_UNIX		1
+#	ifndef MODM_OS_STRING
+#		define MODM_OS_STRING	"Unix-like(generic)"
 #	endif
 #endif
 
 #if defined _WIN32 || defined WIN32 || defined __NT__ || defined __WIN32__
-#	define MODM_OS_HOSTED 1
-#	define MODM_OS_WIN32 1
-#	if defined _WIN64
-#		define MODM_OS_WIN64 1
-#		define MODM_OS_STRING		"Win64"
+#	define MODM_OS_HOSTED	1
+#	define MODM_OS_WIN32	1
+#	ifdef _WIN64
+#		define MODM_OS_WIN64	1
+#		define MODM_OS_STRING	"Win64"
 #	else
-#		if !defined MODM_OS_STRING
+#		ifndef MODM_OS_STRING
 #			define MODM_OS_STRING	"Win32"
 #		endif
 #	endif
 #endif
 
-#define MODM_ORDER_BIG_ENDIAN 4321
-#define MODM_ORDER_LITTLE_ENDIAN 1234
-#define MODM_ORDER_PDP_ENDIAN 3412
-
 // If we did not detect any of Linux, OS X or Windows
-#if !defined(MODM_OS_HOSTED)
+#ifndef MODM_OS_HOSTED
 #	define MODM_OS_NONE	1
 #endif
 
 // ----------------------------------------------------------------------------
 // Determine CPU type
 
-#if defined __AVR__
-#	define MODM_CPU_AVR	1
+#ifdef __AVR__
+#	define MODM_CPU_AVR		1
 #	define MODM_ALIGNMENT	1
-#	if defined __AVR_XMEGA__
+#	ifdef __AVR_XMEGA__
 #		define MODM_CPU_ATXMEGA	1
-#		define MODM_CPU_STRING		"Atmel XMEGA"
+#		define MODM_CPU_STRING	"Atmel XMEGA"
 #	else
 		// see http://www.nongnu.org/avr-libc/user-manual/using_tools.html
 #		if __AVR_ARCH__ == 2 || __AVR_ARCH__ == 25 || __AVR_ARCH__ == 1
@@ -190,23 +186,20 @@
 
 #if defined __X86__ || defined __i386__ || defined i386 || defined _M_IX86 || defined __386__ || defined __x86_64__ || defined _M_X64
 #	if defined __x86_64__ || defined _M_X64
-#		define MODM_CPU_AMD64 1
-#		define MODM_CPU_STRING		"AMD x86-64"
+#		define MODM_CPU_AMD64 	1
+#		define MODM_CPU_STRING	"AMD x86-64"
 #		define MODM_ALIGNMENT	8
 #	else
-#		define MODM_CPU_I386 1
-#		define MODM_CPU_STRING		"Intel 386+"
+#		define MODM_CPU_I386	1
+#		define MODM_CPU_STRING	"Intel 386+"
 #		define MODM_ALIGNMENT	4
 #	endif
 #endif
 
 #if defined __arm__ || defined __aarch64__
-#	define MODM_CPU_ARM	1
+#	define MODM_CPU_ARM		1
 #	define MODM_ALIGNMENT	4
-#	if defined __ARM_ARCH_4T__
-#		define MODM_CPU_ARM7TDMI	1
-#		define MODM_CPU_STRING		"ARM7TDMI"
-#	elif defined __ARM_ARCH_6SM__ || defined __ARM_ARCH_6M__
+#	if defined __ARM_ARCH_6SM__ || defined __ARM_ARCH_6M__
 #		define MODM_CPU_CORTEX_M0	1
 #		define MODM_CPU_STRING		"ARM Cortex-M0"
 #	elif defined __ARM_ARCH_7M__
@@ -218,52 +211,29 @@
 #	elif defined __ARM_ARCH_8M_MAIN__
 #		define MODM_CPU_CORTEX_M33	1
 #		define MODM_CPU_STRING		"ARM Cortex-M33"
-#	elif defined __ARM_ARCH_6__
-#		define MODM_CPU_CORTEX_A6	1
-#		define MODM_CPU_STRING		"ARM Cortex-A6"
-#	elif defined __ARM_ARCH_7A__
-#		define MODM_CPU_CORTEX_A7	1
-#		define MODM_CPU_STRING		"ARM Cortex-A7"
 #	elif defined __ARM_ARCH_ISA_A64
-#		define MODM_CPU_AARCH64	1
+#		define MODM_CPU_AARCH64		1
 #		define MODM_CPU_STRING		"ARM AArch64"
 #	endif
 #endif
 
-#if !defined MODM_CPU_STRING
+#ifndef MODM_CPU_STRING
 #	error "Couldn't determine target CPU!"
-#	define MODM_CPU_STRING 		"Unknown"
+#	define MODM_CPU_STRING	"Unknown"
 #endif
 
 // ----------------------------------------------------------------------------
 // Provide some additional information
 
-#if defined __SIZEOF_POINTER__
-#	define MODM_SIZEOF_POINTER			__SIZEOF_POINTER__
+#ifdef __SIZEOF_POINTER__
+#	define MODM_SIZEOF_POINTER	__SIZEOF_POINTER__
 #else
-#	if defined(MODM_OS_HOSTED_64)
-#		define MODM_SIZEOF_POINTER		8
-#	elif defined(MODM_OS_HOSTED_32)
-#		define MODM_SIZEOF_POINTER		4
-#	endif
-#endif
-
-#if !defined MODM_SIZEOF_POINTER
 #	error "MODM_SIZEOF_POINTER not defined! Please provide a suitable definition."
 #endif
 
+#define MODM_IS_LITTLE_ENDIAN	(__BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__)
+#define MODM_IS_BIG_ENDIAN		(__BYTE_ORDER__ == __ORDER_BIG_ENDIAN__)
 
-#if defined __BYTE_ORDER__
-#	define MODM_BYTE_ORDER		__BYTE_ORDER__
-#endif
-
-#if !defined MODM_BYTE_ORDER
-#	error "MODM_BYTE_ORDER not defined! Please provide a suitable definition."
-#endif
-
-#define MODM_IS_BIG_ENDIAN		(MODM_BYTE_ORDER == MODM_ORDER_BIG_ENDIAN)
-#define MODM_IS_LITTLE_ENDIAN	(MODM_BYTE_ORDER == MODM_ORDER_LITTLE_ENDIAN)
-
-#define MODM_HAS_IOSTREAM __has_include(<modm/io/iostream.hpp>)
+#define MODM_HAS_IOSTREAM		__has_include(<modm/io/iostream.hpp>)
 
 #endif	// !__DOXYGEN__

src/modm/architecture/interface/accessor_flash.hpp

@@ -21,26 +21,22 @@
 
 #ifdef	__DOXYGEN__
 
-/// Define a flash variable
 /// @ingroup modm_architecture_accessor
-#define	FLASH_STORAGE(var)
+/// @{
 
+/// Define a flash variable
+#define	FLASH_STORAGE(var)
 /// Define a flash variable with external linkage
-/// @ingroup modm_architecture_accessor
 #define	EXTERN_FLASH_STORAGE(var)
-
 /// Define a flash string
-/// @ingroup modm_architecture_accessor
 #define	FLASH_STORAGE_STRING(s)
-
 /// Declare a flash string with external linkage
-/// @ingroup modm_architecture_accessor
 #define	EXTERN_FLASH_STORAGE_STRING(s)
-
 /// Declare a flash string inline
-/// @ingroup modm_architecture_accessor
 #define IFSS(s) ((const char *)(s))
 
+/// @}
+
 #else // !__DOXYGEN__
 
 #include <modm/platform/core/flash_reader_impl.hpp>

src/modm/architecture/interface/assert.h.in

@@ -80,7 +80,6 @@ typedef struct modm_packed
 
 #define _modm_assert_get_macro(_1,_2,_3,_4,_modm_assertN,...) _modm_assertN
 
-
 // modm_assert* definitions
 #define modm_assert(...) \
 	_modm_assert_get_macro(__VA_ARGS__, _modm_assert5, _modm_assert4)(0x04, __VA_ARGS__)
@@ -109,3 +108,4 @@ typedef struct modm_packed
 modm_extern_c void
 modm_assert_report(_modm_assertion_info *info);
 /// @endcond
+/// @endcond