From: Justin Seyster <jseyster@cs.sunysb.edu>
Date: Thu, 21 Oct 2010 19:06:29 +0000 (-0400)
Subject: Documentation for aop_filter_entry_by_name().
X-Git-Tag: release-v1.0~20
X-Git-Url: https://git.fsl.cs.stonybrook.edu/?a=commitdiff_plain;h=46b4371f0cb64cfb736d9e68e4c29e075c7a3d55;p=interaspect.git

Documentation for aop_filter_entry_by_name().
---

diff --git a/src/aop-pc-entry.c b/src/aop-pc-entry.c
index 719cdac..162fad5 100644
--- a/src/aop-pc-entry.c
+++ b/src/aop-pc-entry.c
@@ -222,10 +222,18 @@ aop_match_function_entry ()
   return pc;
 }
 
-void aop_filter_entry_by_name(struct aop_pointcut *pc_function_entry,
-			      const char *advice_function_entry)
+/**
+ * Filter a function entry pointcut so it will contain the current
+ * function's entry join point only if the current function's name
+ * matches the specified name.  This filter is a convenient way to
+ * target the entry point of a specific function for instrumentation.
+ * \param pc The function entry pointcut to filter.  Function entry
+ * pointcuts are created with aop_match_function_entry().
+ * \param name The name to filter by.
+ */
+void aop_filter_entry_by_name(struct aop_pointcut *pc, const char *name)
 {
-  pc_function_entry->pc_entry.function_name = advice_function_entry;
+  pc->pc_entry.function_name = name;
 }
 
 /* Close Doxygen defgroup block. */
diff --git a/src/aop.h b/src/aop.h
index 75b640f..55c8c40 100644
--- a/src/aop.h
+++ b/src/aop.h
@@ -333,8 +333,7 @@ extern void aop_filter_by_in_param (struct aop_pointcut *pc, int n,
 extern struct aop_dynval *aop_capture_in_param (struct aop_joinpoint *jp,
 					     int param_index);
 
-extern void aop_filter_entry_by_name(struct aop_pointcut *pc_function_entry,
-				     const char *advice_function_entry);
+extern void aop_filter_entry_by_name(struct aop_pointcut *pc, const char *name);
 
 extern struct aop_pointcut *aop_match_function_exit ();
 extern void aop_filter_exit_by_return_type (struct aop_pointcut *pc,