From e3dcf2785eb09feb798367cde315606fb6a4c88a Mon Sep 17 00:00:00 2001 From: Justin Seyster Date: Wed, 25 Aug 2010 21:28:57 -0400 Subject: [PATCH] Documentation for aop_t_pointer_to(). --- src/aop-type.c | 12 ++++++++++++ 1 file changed, 12 insertions(+) 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) { -- 2.34.1