docs: update documentation

This commit is contained in:
Recep Aslantas
2020-03-19 12:51:05 +03:00
parent 686deb8eb1
commit 7f9487fd62
3 changed files with 26 additions and 2 deletions

View File

@@ -51,3 +51,4 @@ Follow the :doc:`build` documentation for this
sphere
curve
bezier
version

View File

@@ -146,7 +146,7 @@ Functions documentation
| *[in]* **b** b
Returns:
true if a and b equals
true if a and b are equal
.. c:function:: float glm_percent(float from, float to, float current)
@@ -158,7 +158,7 @@ Functions documentation
| *[in]* **current** value between from and to values
Returns:
clamped normalized percent (0-100 in 0-1)
percentage of current value
.. c:function:: float glm_percentc(float from, float to, float current)
@@ -171,3 +171,11 @@ Functions documentation
Returns:
clamped normalized percent (0-100 in 0-1)
.. c:function:: void glm_swapf(float *a, float *b)
swap two float values
Parameters:
| *[in]* **a** float 1
| *[in]* **b** float 2

15
docs/source/version.rst Normal file
View File

@@ -0,0 +1,15 @@
.. default-domain:: C
version
================================================================================
Header: cglm/version.h
**cglm** uses semantic versioning (http://semver.org) which is MAJOR.MINOR.PATCH
**CGLM_VERSION_MAJOR** is major number of the version.
**CGLM_VERSION_MINOR** is minor number of the version.
**CGLM_VERSION_PATCH** is path number of the version.
every release increases these numbers. You can check existing version by
including cglm/version.h