From: Justin Seyster <jseyster@cs.sunysb.edu>
Date: Tue, 24 Aug 2010 22:45:12 +0000 (-0400)
Subject: Documentation for fp types.
X-Git-Tag: release-v1.0~57
X-Git-Url: https://git.fsl.cs.stonybrook.edu/?a=commitdiff_plain;h=41f5d16e6027f34c792b5eabb8689c5a8412959b;p=interaspect.git

Documentation for fp types.
---

diff --git a/src/aop-type.c b/src/aop-type.c
index d6ec8ca..ed37200 100644
--- a/src/aop-type.c
+++ b/src/aop-type.c
@@ -226,6 +226,18 @@ aop_t_all_unsigned ()
   return &_aop_t_all_unsigned;
 }
 
+/**
+ * Return a type that will match any standard-sized floating point
+ * type.
+ *
+ * Standard floating point sizes are single-precision (float) and
+ * double-precision (double).  This type will not match
+ * quadruple-precision floating point types (you must use
+ * aop_t_float128() to match quadruple-precision).
+ *
+ * \return A type that will match any standard-sized floating point
+ * type.
+ */
 const struct aop_type *
 aop_t_all_fp ()
 {
@@ -348,18 +360,36 @@ aop_t_unsigned128 ()
   return &_aop_t_unsigned128;
 }
 
+/**
+ * Return a type that will match single-precision floating point types
+ * (float in C).
+ * \return A type that will match single-precision floating point
+ * types.
+ */
 const struct aop_type *
 aop_t_float32 ()
 {
   return &_aop_t_float32;
 }
 
+/**
+ * Return a type that will match double-precision floating point types
+ * (double in C).
+ * \return A type that will match double-precision floating point
+ * types.
+ */
 const struct aop_type *
 aop_t_float64 ()
 {
   return &_aop_t_float64;
 }
 
+/**
+ * Return a type that will match quadruple-precision floating point
+ * types (long double in C).
+ * \return A type that will match quadruple-precision floating point
+ * types.
+ */
 const struct aop_type *
 aop_t_float128 ()
 {