[*] Documentation

I'm not really trying to document this. This'll make reading the header marginally easier for my forgetful potato brain
This commit is contained in:
Reece Wilson 2021-10-23 18:38:09 +00:00
parent 93c90dc00a
commit 5ac100d878

View File

@ -82,7 +82,9 @@
#define AUI_DEFINE_INTERFACE_START_CPP_WRAPPER_FWD(name, ...) AUI_DEFINE_INTERFACE_START_FUNCTIONAL_BASE(AUI_METHOD_FUNCTIONAL_FWD, name, __VA_ARGS__) #define AUI_DEFINE_INTERFACE_START_CPP_WRAPPER_FWD(name, ...) AUI_DEFINE_INTERFACE_START_FUNCTIONAL_BASE(AUI_METHOD_FUNCTIONAL_FWD, name, __VA_ARGS__)
#define AUI_DEFINE_INTERFACE_START_CPP_WRAPPER_IMPL(name, ...) AUI_DEFINE_INTERFACE_START_FUNCTIONAL_BASE(AUI_METHOD_FUNCTIONAL_IMPL, name, __VA_ARGS__) #define AUI_DEFINE_INTERFACE_START_CPP_WRAPPER_IMPL(name, ...) AUI_DEFINE_INTERFACE_START_FUNCTIONAL_BASE(AUI_METHOD_FUNCTIONAL_IMPL, name, __VA_ARGS__)
#define AUI_METHOD(...) AUI_BRACKET_SCOPE(__VA_ARGS__) #define AUI_METHOD(returnValue, name, parameters) returnValue, name, parameters
/// Not recommended. This will make your code unnecessarily ugly
#define AUI_PARAMS(...) (__VA_ARGS__) #define AUI_PARAMS(...) (__VA_ARGS__)
/// @deprecated /// @deprecated
@ -90,5 +92,8 @@
#define AUI_PIN_ODR(name) static const name ## Functional AU_CONCAT(_Zignoreme_aui, __COUNTER__); #define AUI_PIN_ODR(name) static const name ## Functional AU_CONCAT(_Zignoreme_aui, __COUNTER__);
/// Entrypoint into Aurora Interfaces | Forward declare type
#define AUI_INTERFACE_FWD(name, ...) AUI_DEFINE_INTERFACE_START_STRUCT(name, __VA_ARGS__) AUI_DEFINE_INTERFACE_START_CPP_WRAPPER_FWD(name, __VA_ARGS__) #define AUI_INTERFACE_FWD(name, ...) AUI_DEFINE_INTERFACE_START_STRUCT(name, __VA_ARGS__) AUI_DEFINE_INTERFACE_START_CPP_WRAPPER_FWD(name, __VA_ARGS__)
/// Entrypoint into Aurora Interfaces | Forward declare and define in a single translation unit
#define AUI_INTERFACE_IMPL(name, ...) AUI_DEFINE_INTERFACE_START_STRUCT(name, __VA_ARGS__) AUI_DEFINE_INTERFACE_START_CPP_WRAPPER_IMPL(name, __VA_ARGS__) AUI_PIN_ODR(name) #define AUI_INTERFACE_IMPL(name, ...) AUI_DEFINE_INTERFACE_START_STRUCT(name, __VA_ARGS__) AUI_DEFINE_INTERFACE_START_CPP_WRAPPER_IMPL(name, __VA_ARGS__) AUI_PIN_ODR(name)