Documentation for entry/exit pointcut matching functions.

diff --git a/src/aop-pc-entry.c b/src/aop-pc-entry.c
index b1afec8523dc177dcc369c0d7fddb2eeee727552..870b2b02b8baf13d6234ed72907f0a386f5819dc 100644 (file)
--- a/src/aop-pc-entry.c
+++ b/src/aop-pc-entry.c
@@ -188,6 +188,13 @@ op_prepare_entry (struct aop_joinpoint *jp)
   aop_assert (0);
 }
 
+/**
+ * Get a pointcut with the entry to the current function.  Generally a
+ * pointcut is a set of join points, but because a given function has
+ * only one entry point, the pointcut returned by this function will
+ * have exactly one join point.
+ * \return The resulting pointcut.
+ */
 struct aop_pointcut *
 aop_match_function_entry ()
 {

diff --git a/src/aop-pc-exit.c b/src/aop-pc-exit.c
index b749ebd84fdc2606e2677ebf0eeb71573a5f6b46..4995979ac3855c1aa4aaac6e354770ddcc54701e 100644 (file)
--- a/src/aop-pc-exit.c
+++ b/src/aop-pc-exit.c
@@ -124,6 +124,12 @@ op_prepare_exit (struct aop_joinpoint *jp)
   gsi_insert_before (jp->gsi, nop, GSI_NEW_STMT);
 }
 
+/**
+ * Get a pointcut matching exit points in the current function, which
+ * include explicit return statements and the implicit exit at the end
+ * of the function.
+ * \return The resulting pointcut.
+ */
 struct aop_pointcut *
 aop_match_function_exit ()
 {