aboutsummaryrefslogtreecommitdiff
path: root/src/utils.h
diff options
context:
space:
mode:
authorThomas White <taw@bitwiz.org.uk>2011-03-26 20:26:06 +0100
committerThomas White <taw@physics.org>2012-02-22 15:27:21 +0100
commitcf481c5e99e6923358687d66fd6afecc95625a57 (patch)
treead847b8243eda52ffc8081880dd402dc39e5fbed /src/utils.h
parent03acd73808f6f21bbfc38300796b24ecf823a697 (diff)
Add documentation via gtk-doc
Diffstat (limited to 'src/utils.h')
-rw-r--r--src/utils.h28
1 files changed, 25 insertions, 3 deletions
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;