From: Justin Seyster <jseyster@cs.sunysb.edu>
Date: Wed, 20 Oct 2010 03:27:41 +0000 (-0400)
Subject: Documentation for entry/exit pointcut matching functions.
X-Git-Tag: release-v1.0~28^2~6
X-Git-Url: https://git.fsl.cs.stonybrook.edu/?a=commitdiff_plain;h=1c8afc7ba82276218bb7941d43ba212c20bf3815;p=interaspect.git

Documentation for entry/exit pointcut matching functions.
---

diff --git a/src/aop-pc-entry.c b/src/aop-pc-entry.c
index b1afec8..870b2b0 100644
--- 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 b749ebd..4995979 100644
--- 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 ()
 {