mewin/glm
1
0
Fork 0
Code Releases Activity

Fixed doxygen errors

Browse Source
This commit is contained in:
Christophe Riccio
2011-10-24 17:11:09 +01:00
parent 859833fa62
commit 83f278f922
4 changed files with 26 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
doc/pages.doxy
View File

@@ -28,3 +28,25 @@
These pages are the API reference only. For more information about how to use GLM, please have a look at <a href="http://glm.g-truc.net/glm.pdf">the manual</a>. These pages are the API reference only. For more information about how to use GLM, please have a look at <a href="http://glm.g-truc.net/glm.pdf">the manual</a>.
**/ **/
/*!
\page pg_differences Differences between GLSL and GLM core
GLM comes very close to replicating GLSL, but it is not exact. Here is a list of
differences between GLM and GLSL:
<ul>
<li>
Precision qualifiers. In GLSL numeric types can have qualifiers that define
the precision of that type. While OpenGL's GLSL ignores these qualifiers, OpenGL
ES's version of GLSL uses them.
C++ has no language equivalent to precision qualifiers. Instead, GLM provides
a set of typedefs for each kind of precision qualifier and type. These types can
be found in \ref core_precision "their own section".
Functions that take types tend to be templated on those types, so they can
take these qualified types just as well as the regular ones.
</li>
</ul>
**/

1
glm/core/func_exponential.hpp
View File

@@ -44,6 +44,7 @@ namespace glm
/// Returns x raised to the y power. /// Returns x raised to the y power.
/// ///
/// @param x pow function is defined for input values of x defined in the range (inf-, inf+) in the limit of the type precision. /// @param x pow function is defined for input values of x defined in the range (inf-, inf+) in the limit of the type precision.
/// @param y
/// @tparam genType Floating-point scalar or vector types. /// @tparam genType Floating-point scalar or vector types.
/// ///
/// @see - <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/pow.xml">GLSL pow man page</a> /// @see - <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/pow.xml">GLSL pow man page</a>

2
glm/gtx/constants.hpp
View File

@@ -20,7 +20,7 @@
/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN /// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
/// THE SOFTWARE. /// THE SOFTWARE.
/// ///
/// @ref constants /// @ref gtx_constants
/// @file glm/gtx/constants.hpp /// @file glm/gtx/constants.hpp
/// @date 2011-09-30 / 2011-09-30 /// @date 2011-09-30 / 2011-09-30
/// @author Christophe Riccio /// @author Christophe Riccio

4
glm/gtx/integer.hpp
View File

@@ -60,8 +60,8 @@ namespace glm
//! Returns the log2 of x. Can be reliably using to compute mipmap count from the texture size. //! Returns the log2 of x. Can be reliably using to compute mipmap count from the texture size.
//! From GLM_GTX_integer extension. //! From GLM_GTX_integer extension.
template <typename genType> template <typename genIUType>
genType log2(genType const & x); genIUType log2(genIUType const & x);
//! Returns the floor log2 of x. //! Returns the floor log2 of x.
//! From GLM_GTX_integer extension. //! From GLM_GTX_integer extension.