Added docs for aop_capture_lineno() and aop_capture_file_name().

diff --git a/src/aop-pointcut.c b/src/aop-pointcut.c
index 36636666fa4c7bdb9cb7393297aebc7eec2733f8..0e0fd7684bb10666bf92a0e1fcfc8984efb6a919 100644 (file)
--- 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)
 {