From ad60108e2c321c74e80577dfc5aeaee42b41f4f5 Mon Sep 17 00:00:00 2001 From: Christophe Riccio Date: Thu, 12 May 2011 17:36:29 +0100 Subject: [PATCH] Added more doxygen documentation --- doc/coreModules.doxy | 2 ++ glm/glm.hpp | 2 +- glm/gtc/half_float.hpp | 10 +++++----- glm/gtc/matrix_transform.hpp | 15 +++++++-------- glm/gtc/quaternion.hpp | 16 ++++++++-------- 5 files changed, 23 insertions(+), 22 deletions(-) diff --git a/doc/coreModules.doxy b/doc/coreModules.doxy index 1961ff71..df3df17f 100644 --- a/doc/coreModules.doxy +++ b/doc/coreModules.doxy @@ -12,6 +12,8 @@ version 4.1 (pdf file). There are a few \ref pg_differences "differences" between GLM core and GLSL. + + GLM core functionnalities requires to be included to be used. **/ diff --git a/glm/glm.hpp b/glm/glm.hpp index 394ecf4b..ec5afbb1 100644 --- a/glm/glm.hpp +++ b/glm/glm.hpp @@ -4,7 +4,7 @@ // Created : 2005-01-14 // Updated : 2011-01-19 // Licence : This source is under MIT License -// File : glm/glm.hpp +//! \file glm/glm.hpp /////////////////////////////////////////////////////////////////////////////////////////////////// #include "core/_fixes.hpp" diff --git a/glm/gtc/half_float.hpp b/glm/gtc/half_float.hpp index 9c9d81e1..ea50c0c3 100644 --- a/glm/gtc/half_float.hpp +++ b/glm/gtc/half_float.hpp @@ -1,10 +1,10 @@ /////////////////////////////////////////////////////////////////////////////////////////////////// -// OpenGL Mathematics Copyright (c) 2005 - 2011 G-Truc Creation (www.g-truc.net) +//! OpenGL Mathematics Copyright (c) 2005 - 2011 G-Truc Creation (www.g-truc.net) /////////////////////////////////////////////////////////////////////////////////////////////////// -// Created : 2009-04-29 -// Updated : 2010-02-07 -// Licence : This source is under MIT License -// File : glm/gtc/half_float.hpp +//! Created : 2009-04-29 +//! Updated : 2010-02-07 +//! Licence : This source is under MIT License +//! \file glm/gtc/half_float.hpp /////////////////////////////////////////////////////////////////////////////////////////////////// #ifndef glm_gtc_half_float diff --git a/glm/gtc/matrix_transform.hpp b/glm/gtc/matrix_transform.hpp index 241bb3ac..8505e22e 100644 --- a/glm/gtc/matrix_transform.hpp +++ b/glm/gtc/matrix_transform.hpp @@ -1,14 +1,13 @@ /////////////////////////////////////////////////////////////////////////////////////////////////// -// OpenGL Mathematics Copyright (c) 2005 - 2011 G-Truc Creation (www.g-truc.net) +//! OpenGL Mathematics Copyright (c) 2005 - 2011 G-Truc Creation (www.g-truc.net) /////////////////////////////////////////////////////////////////////////////////////////////////// -// Created : 2009-04-29 -// Updated : 2009-04-29 -// Licence : This source is under MIT License -// File : glm/gtc/matrix_transform.hpp +//! Created : 2009-04-29 +//! Updated : 2009-04-29 +//! Licence : This source is under MIT License +//! \file glm/gtc/matrix_transform.hpp /////////////////////////////////////////////////////////////////////////////////////////////////// -// Dependency: -// - GLM core -// - GLM_GTC_matrix_operation +//! Dependency: +//! - GLM core /////////////////////////////////////////////////////////////////////////////////////////////////// #ifndef glm_gtc_matrix_transform diff --git a/glm/gtc/quaternion.hpp b/glm/gtc/quaternion.hpp index bc4890fd..cf1c4b27 100644 --- a/glm/gtc/quaternion.hpp +++ b/glm/gtc/quaternion.hpp @@ -1,14 +1,14 @@ /////////////////////////////////////////////////////////////////////////////////////////////////// -// OpenGL Mathematics Copyright (c) 2005 - 2011 G-Truc Creation (www.g-truc.net) +//! OpenGL Mathematics Copyright (c) 2005 - 2011 G-Truc Creation (www.g-truc.net) /////////////////////////////////////////////////////////////////////////////////////////////////// -// Created : 2009-05-21 -// Updated : 2010-02-04 -// Licence : This source is under MIT License -// File : glm/gtc/quaternion.hpp +//! Created : 2009-05-21 +//! Updated : 2010-02-04 +//! Licence : This source is under MIT License +//! \file glm/gtc/quaternion.hpp /////////////////////////////////////////////////////////////////////////////////////////////////// -// Dependency: -// - GLM core -// - GLM_GTC_half_float +//! Dependency: +//! - GLM core +//! - \link glm/gtc/half_float.hpp GLM_GTC_half_float \endlink /////////////////////////////////////////////////////////////////////////////////////////////////// // ToDo: // - Study constructors with angles and axis