From: Justin Seyster <jseyster@cs.sunysb.edu>
Date: Sat, 3 Jul 2010 00:37:38 +0000 (-0400)
Subject: Added Doxygen main page and groups for each type of pointcut.
X-Git-Tag: release-v1.0~91^2
X-Git-Url: https://git.fsl.cs.stonybrook.edu/?a=commitdiff_plain;h=a4a07a0dba86fec8bc3bae597eaec9d5140868a9;p=interaspect.git

Added Doxygen main page and groups for each type of pointcut.
---

diff --git a/src/aop-doxy-main.c b/src/aop-doxy-main.c
new file mode 100644
index 0000000..6428f70
--- /dev/null
+++ b/src/aop-doxy-main.c
@@ -0,0 +1,29 @@
+/* This program is free software: you can redistribute it and/or
+   modify it under the terms of the GNU General Public License as
+   published by the Free Software Foundation, either version 3 of the
+   License, or (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful, but
+   WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+   General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#error This file serves only as documentation.  Do not compile it.
+
+/**
+ * \defgroup assign_pc Assignment Pointcut Functions
+ */
+
+/** \mainpage The InterAspect Framework
+ *
+ * \section pc Pointcuts
+ * InterAspect defines four types of pointcuts.
+ * - \ref entry_pc "Function entry" pointcuts.
+ * - \ref exit_pc "Function exit" pointcuts.
+ * - \ref call_pc "Function call" pointcuts.
+ * - \ref assign_pc "Assignment" pointcuts.
+ */
diff --git a/src/aop-pc-assign.c b/src/aop-pc-assign.c
index 6600437..96cf5ad 100644
--- a/src/aop-pc-assign.c
+++ b/src/aop-pc-assign.c
@@ -38,6 +38,11 @@
 #include "aop-pointcut.h"
 #include "aop-type.h"
 
+/**
+ * \defgroup assign_pc Assignment Pointcut Functions
+ * \{
+ */
+
 /**
  * Get the name of the variable being assigned to in an assignment
  * joinpoint.
@@ -360,3 +365,8 @@ aop_match_assignment_by_type (const struct aop_type *type)
 
   return pc;
 }
+
+/* Close Doxygen defgroup block. */
+/**
+ * /}
+ */
diff --git a/src/aop-pc-entry.c b/src/aop-pc-entry.c
index 6129435..293a299 100644
--- a/src/aop-pc-entry.c
+++ b/src/aop-pc-entry.c
@@ -37,6 +37,11 @@
 #include "aop-pointcut.h"
 #include "aop-type.h"
 
+/**
+ * \defgroup entry_pc Function Entry Pointcut Functions
+ * \{
+ */
+
 static void
 op_join_on_function_entry (struct aop_pointcut *pc, join_callback cb,
 			   void *callback_param)
@@ -127,3 +132,8 @@ void aop_filter_entry_by_name(struct aop_pointcut *pc_function_entry,
 {
   pc_function_entry->pc_entry.function_name = advice_function_entry;
 }
+
+/* Close Doxygen defgroup block. */
+/**
+ * /}
+ */
diff --git a/src/aop-pc-exit.c b/src/aop-pc-exit.c
index c8b7fc7..56e1f57 100644
--- a/src/aop-pc-exit.c
+++ b/src/aop-pc-exit.c
@@ -37,6 +37,11 @@
 #include "aop-pointcut.h"
 #include "aop-type.h"
 
+/**
+ * \defgroup exit_pc Function Exit Pointcut Functions
+ * \{
+ */
+
 static void
 op_join_on_function_exit (struct aop_pointcut *pc, join_callback cb, 
 			  void *callback_param)
@@ -106,3 +111,8 @@ aop_match_function_exit ()
   pc->prepare_for_weave = op_prepare_exit;
   return pc;
 }
+
+/* Close Doxygen defgroup block. */
+/**
+ * /}
+ */
diff --git a/src/aop-pc-fun-call.c b/src/aop-pc-fun-call.c
index ff5c846..0f96974 100644
--- a/src/aop-pc-fun-call.c
+++ b/src/aop-pc-fun-call.c
@@ -38,6 +38,11 @@
 #include "aop-type.h"
 #include "aop-dynval.h"
 
+/**
+ * \defgroup call_pc Function Call Pointcut Functions
+ * \{
+ */
+
 /* Returns true if func_decl matches the arguments described in
    param_list by type. */
 static bool
@@ -230,3 +235,7 @@ aop_capture_param (struct aop_joinpoint *jp, int param_index)
   return dv;
 }
 
+/* Close Doxygen defgroup block. */
+/**
+ * /}
+ */