From 2def53cde1dd6b2ce10b1c77532ee96cb54cf670 Mon Sep 17 00:00:00 2001 From: Justin Seyster Date: Wed, 27 Oct 2010 17:19:34 -0400 Subject: [PATCH] Documentation for AOP_TERM_ARG. --- Doxyfile | 2 +- src/aop.h | 15 +++++++++++++++ 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/Doxyfile b/Doxyfile index dc1733a..af94294 100644 --- a/Doxyfile +++ b/Doxyfile @@ -1257,7 +1257,7 @@ INCLUDE_FILE_PATTERNS = # undefined via #undef or recursively expanded use the := operator # instead of the = operator. -PREDEFINED = +PREDEFINED = DOXY_ONLY # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then # this tag can be used to specify a list of macro names that should be expanded. diff --git a/src/aop.h b/src/aop.h index cac5fec..819db7f 100644 --- a/src/aop.h +++ b/src/aop.h @@ -322,6 +322,21 @@ enum aop_argkind { */ #define AOP_DYNVAL(VAL) ATA_DYNVAL, VAL +/* This is an unfortunate hack so that we can have doxygen + documentation for AOP_TERM_ARG. */ +#ifdef DOXY_ONLY +#error Do not define the DOXY_ONLY preprocessor variable. + +/** + * \brief End a list of advice arguments. + * + * This value must always be the last thing passed to + * aop_insert_advice() and aop_duplicate(), even if you are not + * passing any advice arguments. + */ +#define AOP_TERM_ARG +#endif + /** * \} */ -- 2.34.1