Improve the library documentation.
Add many comments to the core math library. Fix mulitple errors encountered when running doxygen.
Change-Id: Icbc9d8f5b5353c40b1ed6b04baef3d5c6b5888f1
diff --git a/scriptc/rs_quaternion.rsh b/scriptc/rs_quaternion.rsh
index 4e08d2f..d2ec24c 100644
--- a/scriptc/rs_quaternion.rsh
+++ b/scriptc/rs_quaternion.rsh
@@ -26,6 +26,7 @@
/**
* Set the quaternion components
+ * @param q destination quaternion
* @param w component
* @param x component
* @param y component
@@ -68,7 +69,7 @@
/**
* Add two quaternions
* @param q destination quaternion to add to
- * @param rsh right hand side quaternion to add
+ * @param rhs right hand side quaternion to add
*/
static void
rsQuaternionAdd(rs_quaternion *q, const rs_quaternion *rhs) {
@@ -84,7 +85,7 @@
* @param rot angle to rotate by
* @param x component of a vector
* @param y component of a vector
- * @param x component of a vector
+ * @param z component of a vector
*/
static void
rsQuaternionLoadRotateUnit(rs_quaternion *q, float rot, float x, float y, float z) {
@@ -105,7 +106,7 @@
* @param rot angle to rotate by
* @param x component of a vector
* @param y component of a vector
- * @param x component of a vector
+ * @param z component of a vector
*/
static void
rsQuaternionLoadRotate(rs_quaternion *q, float rot, float x, float y, float z) {
@@ -223,7 +224,7 @@
/**
* Computes rotation matrix from the normalized quaternion
* @param m resulting matrix
- * @param p normalized quaternion
+ * @param q normalized quaternion
*/
static void rsQuaternionGetMatrixUnit(rs_matrix4x4 *m, const rs_quaternion *q) {
float xx = q->x * q->x;
@@ -250,4 +251,3 @@
}
#endif
-