Craig Evans / Utils

Just a header file containing structs and constants etc. that are used across my libraries. Prevents multiple declarations.

Dependents:   Leg

Files at this revision

API Documentation at this revision

Revision 3:930ff1d43de4, committed 2015-06-20

Comitter:
eencae
Date:
Sat Jun 20 14:26:35 2015 +0000
Parent:
2:78a1e4572f84
Commit message:
Added documentation.

Changed in this revision

Utils.h Show annotated file Show diff for this revision Revisions of this file 
diff -r 78a1e4572f84 -r 930ff1d43de4 Utils.h
--- a/Utils.h	Sat Jun 20 13:53:00 2015 +0000
+++ b/Utils.h	Sat Jun 20 14:26:35 2015 +0000
@@ -1,3 +1,14 @@
+/**
+@file Utils.h
+
+@brief Header file containing various structs and convenience methods
+
+@author Craig A. Evans
+@date June 2015
+
+
+*/
+
 #ifndef UTILS_H
 #define UTILS_H
 
@@ -19,14 +30,19 @@
 
 typedef struct pose_t pose_t;
 struct pose_t {
-    float tx;
-    float ty;
-    float tz;
-    float pitch;
-    float roll;
-    float yaw;
+    float tx;  // translation in x
+    float ty;  // translation in y
+    float tz;  // translation in z
+    float pitch;  // rotation around x
+    float roll;   // rotation around y
+    float yaw;    // rotation around z
 };
 
+/** Vector constructor (floats)
+* @param x - x value
+* @param y - y value
+* @param z - z value
+*/
 vector_t create_vector(float x,float y,float z);
 
 #endif
\ No newline at end of file