From cf481c5e99e6923358687d66fd6afecc95625a57 Mon Sep 17 00:00:00 2001
From: Thomas White <taw@bitwiz.org.uk>
Date: Sat, 26 Mar 2011 20:26:06 +0100
Subject: Add documentation via gtk-doc

---
 src/utils.h | 28 +++++++++++++++++++++++++---
 1 file changed, 25 insertions(+), 3 deletions(-)

(limited to 'src/utils.h')

diff --git a/src/utils.h b/src/utils.h
index 169892d4..a7a93404 100644
--- a/src/utils.h
+++ b/src/utils.h
@@ -45,8 +45,25 @@
 
 /* ------------------------------ Quaternions ------------------------------- */
 
-struct quaternion
-{
+/**
+ * quaternion:
+ *
+ * <programlisting>
+ * struct quaternion
+ * {
+ *    double w
+ *    double x
+ *    double y
+ *    double z
+ * };
+ * </programlisting>
+ *
+ * A structure representing a quaternion.
+ *
+ **/
+struct quaternion;
+
+struct quaternion {
 	double w;
 	double x;
 	double y;
@@ -186,7 +203,12 @@ static inline double angle_between(double x1, double y1, double z1,
 
 /* ----------- Reflection lists indexed by sequence (not indices) ----------- */
 
-typedef struct _reflitemlist ReflItemList;  /* Opaque */
+/**
+ * ReflItemList
+ *
+ * Opaque type.
+ **/
+typedef struct _reflitemlist ReflItemList;
 
 struct refl_item {
 	signed int h;
-- 
cgit v1.2.3