From be3f117374305453fe0c32f52ff6849a109f4f36 Mon Sep 17 00:00:00 2001
From: Recep Aslantas <info@recp.me>
Date: Mon, 26 Feb 2018 17:10:33 +0300
Subject: [PATCH] docs: add docs for vec3-ext

---
 docs/source/api.rst      |  1 +
 docs/source/vec3-ext.rst | 98 ++++++++++++++++++++++++++++++++++++++++
 include/cglm/vec3-ext.h  | 32 ++++++-------
 3 files changed, 115 insertions(+), 16 deletions(-)
 create mode 100644 docs/source/vec3-ext.rst

diff --git a/docs/source/api.rst b/docs/source/api.rst
index 57fe2b3..40a30d5 100644
--- a/docs/source/api.rst
+++ b/docs/source/api.rst
@@ -30,3 +30,4 @@ Follow the :doc:`build` documentation for this
    mat4
    mat3
    vec3
+   vec3-ext
diff --git a/docs/source/vec3-ext.rst b/docs/source/vec3-ext.rst
new file mode 100644
index 0000000..f93ff82
--- /dev/null
+++ b/docs/source/vec3-ext.rst
@@ -0,0 +1,98 @@
+.. default-domain:: C
+
+vec3 extra
+==========
+
+Header: cglm/vec3-ext.h
+
+There are some functions are in called in extra header. These are called extra
+because they are not used like other functions in vec3.h in the future some of
+these functions ma be moved to vec3 header.
+
+Table of contents (clik func/macro to go):
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Functions:
+
+1. :c:func:`glm_vec_mulv`
+#. :c:func:`glm_vec_broadcast`
+#. :c:func:`glm_vec_eq`
+#. :c:func:`glm_vec_eq_eps`
+#. :c:func:`glm_vec_eq_all`
+#. :c:func:`glm_vec_eqv`
+#. :c:func:`glm_vec_eqv_eps`
+#. :c:func:`glm_vec_max`
+#. :c:func:`glm_vec_min`
+
+Functions documentation
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. c:function:: void  glm_vec_mulv(vec3 a, vec3 b, vec3 d)
+
+    multiplies individual items
+
+    Parameters:
+      | *[in]*  **a**  vec1
+      | *[in]*  **b**  vec2
+      | *[out]* **d**  destination (v1[0] * v2[0], v1[1] * v2[1], v1[2] * v2[2])
+
+.. c:function:: void  glm_vec_broadcast(float val, vec3 d)
+
+    fill a vector with specified value
+
+    Parameters:
+      | *[in]*  **val**   value
+      | *[out]* **dest**  destination
+
+.. c:function:: bool  glm_vec_eq(vec3 v, float val)
+
+    check if vector is equal to value (without epsilon)
+
+    Parameters:
+      | *[in]*  **v**    vector
+      | *[in]*  **val**  value
+
+.. c:function:: bool  glm_vec_eq_eps(vec4 v, float val)
+
+    check if vector is equal to value (with epsilon)
+
+    Parameters:
+      | *[in]*  **v**    vector
+      | *[in]*  **val**  value
+
+.. c:function:: bool  glm_vec_eq_all(vec3 v)
+
+    check if vectors members are equal (without epsilon)
+
+    Parameters:
+      | *[in]*  **v**   vector
+
+.. c:function:: bool  glm_vec_eqv(vec3 v1, vec3 v2)
+
+    check if vector is equal to another (without epsilon) vector
+
+    Parameters:
+      | *[in]*  **vec**   vector 1
+      | *[in]*  **vec**   vector 2
+
+.. c:function:: bool  glm_vec_eqv_eps(vec3 v1, vec3 v2)
+
+    check if vector is equal to another (with epsilon)
+
+    Parameters:
+      | *[in]*  **v1**    vector1
+      | *[in]*  **v2**    vector2
+
+.. c:function:: float  glm_vec_max(vec3 v)
+
+    max value of vector
+
+    Parameters:
+      | *[in]*  **v**    vector
+
+.. c:function:: float glm_vec_min(vec3 v)
+
+     min value of vector
+
+    Parameters:
+      | *[in]*  **v**  vector
diff --git a/include/cglm/vec3-ext.h b/include/cglm/vec3-ext.h
index 41c1749..c9bffe3 100644
--- a/include/cglm/vec3-ext.h
+++ b/include/cglm/vec3-ext.h
@@ -33,9 +33,9 @@
 /*!
  * @brief multiplies individual items, just for convenient like SIMD
  *
- * @param a vec1
- * @param b vec2
- * @param d vec3 = (v1[0] * v2[0],  v1[1] * v2[1], v1[2] * v2[2])
+ * @param[in]  a vec1
+ * @param[in]  b vec2
+ * @param[out] d vec3 = (v1[0] * v2[0],  v1[1] * v2[1], v1[2] * v2[2])
  */
 CGLM_INLINE
 void
@@ -48,8 +48,8 @@ glm_vec_mulv(vec3 a, vec3 b, vec3 d) {
 /*!
  * @brief fill a vector with specified value
  *
- * @param val value
- * @param d   dest
+ * @param[in]  val value
+ * @param[out] d   dest
  */
 CGLM_INLINE
 void
@@ -60,8 +60,8 @@ glm_vec_broadcast(float val, vec3 d) {
 /*!
  * @brief check if vector is equal to value (without epsilon)
  *
- * @param v   vector
- * @param val value
+ * @param[in] v   vector
+ * @param[in] val value
  */
 CGLM_INLINE
 bool
@@ -72,8 +72,8 @@ glm_vec_eq(vec3 v, float val) {
 /*!
  * @brief check if vector is equal to value (with epsilon)
  *
- * @param v   vector
- * @param val value
+ * @param[in] v   vector
+ * @param[in] val value
  */
 CGLM_INLINE
 bool
@@ -86,7 +86,7 @@ glm_vec_eq_eps(vec4 v, float val) {
 /*!
  * @brief check if vectors members are equal (without epsilon)
  *
- * @param v   vector
+ * @param[in] v   vector
  */
 CGLM_INLINE
 bool
@@ -97,8 +97,8 @@ glm_vec_eq_all(vec3 v) {
 /*!
  * @brief check if vector is equal to another (without epsilon)
  *
- * @param v1 vector
- * @param v2 vector
+ * @param[in] v1 vector
+ * @param[in] v2 vector
  */
 CGLM_INLINE
 bool
@@ -111,8 +111,8 @@ glm_vec_eqv(vec3 v1, vec3 v2) {
 /*!
  * @brief check if vector is equal to another (with epsilon)
  *
- * @param v1 vector
- * @param v2 vector
+ * @param[in] v1 vector
+ * @param[in] v2 vector
  */
 CGLM_INLINE
 bool
@@ -125,7 +125,7 @@ glm_vec_eqv_eps(vec3 v1, vec3 v2) {
 /*!
  * @brief max value of vector
  *
- * @param v vector
+ * @param[in] v vector
  */
 CGLM_INLINE
 float
@@ -144,7 +144,7 @@ glm_vec_max(vec3 v) {
 /*!
  * @brief min value of vector
  *
- * @param v vector
+ * @param[in] v vector
  */
 CGLM_INLINE
 float