From f5fd037ade6b5c40ecf52e28c10543885f9cfc6b Mon Sep 17 00:00:00 2001 From: Christophe Riccio Date: Fri, 20 May 2011 18:58:29 +0100 Subject: [PATCH] Updated doxygen documentation --- glm/gtc/matrix_access.hpp | 63 +++++++++++++++++++++++++-------------- 1 file changed, 40 insertions(+), 23 deletions(-) diff --git a/glm/gtc/matrix_access.hpp b/glm/gtc/matrix_access.hpp index 670fa909..f9f7feae 100644 --- a/glm/gtc/matrix_access.hpp +++ b/glm/gtc/matrix_access.hpp @@ -1,14 +1,32 @@ -/////////////////////////////////////////////////////////////////////////////////////////////////// -// OpenGL Mathematics Copyright (c) 2005 - 2011 G-Truc Creation (www.g-truc.net) -/////////////////////////////////////////////////////////////////////////////////////////////////// -// Created : 2005-12-27 -// Updated : 2010-11-12 -// Licence : This source is under MIT License -// File : glm/gtc/matrix_access.hpp -/////////////////////////////////////////////////////////////////////////////////////////////////// -// Dependency: -// - GLM core -/////////////////////////////////////////////////////////////////////////////////////////////////// +/////////////////////////////////////////////////////////////////////////////////// +/// OpenGL Mathematics (glm.g-truc.net) +/// +/// Copyright (c) 2005 - 2011 G-Truc Creation (www.g-truc.net) +/// Permission is hereby granted, free of charge, to any person obtaining a copy +/// of this software and associated documentation files (the "Software"), to deal +/// in the Software without restriction, including without limitation the rights +/// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +/// copies of the Software, and to permit persons to whom the Software is +/// furnished to do so, subject to the following conditions: +/// +/// The above copyright notice and this permission notice shall be included in +/// all copies or substantial portions of the Software. +/// +/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +/// THE SOFTWARE. +/// +/// @ref gtc_matrix_access +/// @file glm/gtc/matrix_access.hpp +/// @date 2005-12-27 / 2011-05-16 +/// @author Christophe Riccio +/// +/// @see core (dependence) +/////////////////////////////////////////////////////////////////////////////////// #ifndef glm_gtc_matrix_access #define glm_gtc_matrix_access @@ -24,41 +42,40 @@ namespace glm{ namespace gtc{ namespace matrix_access ///< GLM_GTC_matrix_access extension: Set a column or a row of a matrix { - /// \addtogroup gtc_matrix_access - ///@{ + /// @addtogroup gtc_matrix_access + /// @{ - //! Get a specific row of a matrix. - //! From GLM_GTC_matrix_access extension. + /// Get a specific row of a matrix. + /// @see - gtc_matrix_access template typename genType::row_type row( genType const & m, int index); - //! Set a specific row to a matrix. - //! From GLM_GTC_matrix_access extension. + /// Set a specific row to a matrix. + /// @see - gtc_matrix_access template genType row( genType const & m, int index, typename genType::row_type const & x); - //! Get a specific column of a matrix. - //! From GLM_GTC_matrix_access extension. + /// Get a specific column of a matrix. + /// @see - gtc_matrix_access template typename genType::col_type column( genType const & m, int index); - //! Set a specific column to a matrix. - //! From GLM_GTC_matrix_access extension. + /// Set a specific column to a matrix. + /// @see - gtc_matrix_access template genType column( genType const & m, int index, typename genType::col_type const & x); - ///@} - + /// @} }//namespace matrix_access }//namespace gtc }//namespace glm