From: Justin Seyster <jseyster@cs.sunysb.edu>
Date: Wed, 20 Oct 2010 03:01:51 +0000 (-0400)
Subject: Added docs for aop_capture_lineno() and aop_capture_file_name().
X-Git-Tag: release-v1.0~28^2~9
X-Git-Url: https://git.fsl.cs.stonybrook.edu/?a=commitdiff_plain;h=591f8ef774a8f29e9ff8c056a148ad09bef104ab;p=interaspect.git

Added docs for aop_capture_lineno() and aop_capture_file_name().
---

diff --git a/src/aop-pointcut.c b/src/aop-pointcut.c
index 3663666..0e0fd76 100644
--- a/src/aop-pointcut.c
+++ b/src/aop-pointcut.c
@@ -67,12 +67,25 @@ init_joinpoint (struct aop_joinpoint *jp, gimple_stmt_iterator *gsi,
   
 }
 
+/**
+ * Get the line number of join point.  You usually want to call this
+ * with aop_capture_file_name() to fully identify the line of code the
+ * join point is from.
+ * \param jp Any join point.
+ */
 int
 aop_capture_lineno (struct aop_joinpoint *jp)
 {
   return jp->line;
 }
 
+/**
+ * Get the name of the file this join point is in.  This function will
+ * usually return the name of the file that is currently being
+ * compiled, but compiler macros make it possible for their to be join
+ * points from other files.
+ * \param jp Any join point.
+ */
 const char *
 aop_capture_file_name (struct aop_joinpoint *jp)
 {