From: Justin Seyster <jseyster@cs.sunysb.edu>
Date: Thu, 21 Oct 2010 18:52:09 +0000 (-0400)
Subject: Added documentation for noinstrument.
X-Git-Tag: release-v1.0~21
X-Git-Url: https://git.fsl.cs.stonybrook.edu/?a=commitdiff_plain;h=861d4eef63233c5d9caf011d54f457b7f309c59e;p=interaspect.git

Added documentation for noinstrument.
---

diff --git a/src/aop-doxy-main.c b/src/aop-doxy-main.c
index eafdde8..5a81972 100644
--- a/src/aop-doxy-main.c
+++ b/src/aop-doxy-main.c
@@ -122,6 +122,25 @@
  * - struct aop_joinpoint
  * - struct aop_dynval
  * - struct aop_type
+ *
+ * \section noinstrument Noinstrument
+ *
+ * InterAspect adds a <code>noinstrument</code> attribute that you can
+ * use to disable instrumentation for a specific function in the
+ * target program.  Any pass that you register with
+ * aop_register_pass() will skip over functions marked
+ * <code>noinstrument</code>.
+ *
+ * You can mark a function with this attribute using GCC's attribute
+ * syntax:
+ * \code
+ * __attribute__((noinstrument)) void foo() {
+ * \endcode
+ *
+ * The <code>noinstrument</code> attribute is especially useful for
+ * ensuring that advice functions and the functions they call do not
+ * themselves get instrumented (which can cause unbounded recursion
+ * and other problems).
  */
 
 /**