Documentation for the aop_pointcut.

diff --git a/src/aop-doxy-main.c b/src/aop-doxy-main.c
index cf83099cbc30a8a4816afb953cdc5efd472172eb..025743f130b9fa8e5f565d4c89cd1aaafa998679 100644 (file)
--- a/src/aop-doxy-main.c
+++ b/src/aop-doxy-main.c
@@ -93,6 +93,24 @@
  * documentation.
  */
 
+/**
+ * \struct aop_pointcut
+ * \brief A set of \ref aop_joinpoint "join points" in the current
+ * function that are available for instrumentation.
+ *
+ * Create a pointcut using one of the <code>aop_match</code>
+ * functions.  Some types of pointcuts can be further refined using
+ * <code>aop_filter</code> functions.  Iterate through the individual
+ * join points in a pointcut using the aop_join_on() function, which
+ * calls an iterator function once for each of the join points in the
+ * set.
+ *
+ * A pointcut stays valid for the duration of the compiler pass it is
+ * created in.  You should never store a pointer to an aop_pointcut in
+ * any global data structure, in order to avoid any accesses to the
+ * join point after it becomes invalid.
+ */
+
 /**
  * \struct aop_dynval
  * \brief Representation of a runtime value.