From: Justin Seyster <jseyster@cs.sunysb.edu>
Date: Thu, 26 Aug 2010 01:28:57 +0000 (-0400)
Subject: Documentation for aop_t_pointer_to().
X-Git-Tag: release-v1.0~54
X-Git-Url: https://git.fsl.cs.stonybrook.edu/?a=commitdiff_plain;h=e3dcf2785eb09feb798367cde315606fb6a4c88a;p=interaspect.git

Documentation for aop_t_pointer_to().
---

diff --git a/src/aop-type.c b/src/aop-type.c
index 113fc02..0f7912c 100644
--- a/src/aop-type.c
+++ b/src/aop-type.c
@@ -497,6 +497,18 @@ aop_t_float128 ()
   return &_aop_t_float128;
 }
 
+/**
+ * Return a type that will match pointers to the specified type.
+ *
+ * NB: It is possible to match pointers to aop_t_all_signed(),
+ * aop_t_all_unsigned(), or aop_t_all_fp(), but it is dangerous to
+ * then capture the matched value and pass it to an advice function.
+ * The advice function will have no way of knowing which type was
+ * matched.  For example, if an advice function gets a pointer to an
+ * "all fp" value, should it dereference it as a double or a float?
+ *
+ * \return A type that will match pointers to the specified type.
+ */
 const struct aop_type *
 aop_t_pointer_to (const struct aop_type *type)
 {