Documentation for AOP_TERM_ARG.

diff --git a/Doxyfile b/Doxyfile
index dc1733a523f6bb526787747e5b845fcd4813bc59..af9429419a2cbd1e479a5099b1d231020cf3b710 100644 (file)
--- 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 cac5fec10c69da0e0065409ef66d19b7631f8432..819db7f4f383f9615d08ebe7876acd180a3b65b8 100644 (file)
--- 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 <i>always</i> 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
+
 /**
  * \}
  */