Documentation for aop_t_pointer_to().

diff --git a/src/aop-type.c b/src/aop-type.c
index 113fc023af8a408056d52a27046ff1abb257c5c8..0f7912cec5676517f368caad73503d1eec33c08c 100644 (file)
--- 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)
 {