mirror of
https://github.com/g-truc/glm.git
synced 2025-04-08 06:43:10 +00:00
Fixed documentation warnings, issue #46
This commit is contained in:
parent
e359439b86
commit
fc77c7a54e
4 changed files with 22 additions and 55 deletions
|
@ -213,22 +213,22 @@ namespace glm
|
|||
typename genType::value_type const & minVal,
|
||||
typename genType::value_type const & maxVal);
|
||||
|
||||
//! @return If genTypeU is a floating scalar or vector:
|
||||
//! Returns x * (1.0 - a) + y * a, i.e., the linear blend of
|
||||
//! x and y using the floating-point value a.
|
||||
//! The value for a is not restricted to the range [0, 1].
|
||||
//!
|
||||
//! @return If genTypeU is a boolean scalar or vector:
|
||||
//! Selects which vector each returned component comes
|
||||
//! from. For a component of a that is false, the
|
||||
//! corresponding component of x is returned. For a
|
||||
//! component of a that is true, the corresponding
|
||||
//! component of y is returned. Components of x and y that
|
||||
//! are not selected are allowed to be invalid floating point
|
||||
//! values and will have no effect on the results. Thus, this
|
||||
//! provides different functionality than
|
||||
//! genType mix(genType x, genType y, genType(a))
|
||||
//! where a is a Boolean vector.
|
||||
/// If genTypeU is a floating scalar or vector:
|
||||
/// Returns x * (1.0 - a) + y * a, i.e., the linear blend of
|
||||
/// x and y using the floating-point value a.
|
||||
/// The value for a is not restricted to the range [0, 1].
|
||||
///
|
||||
/// If genTypeU is a boolean scalar or vector:
|
||||
/// Selects which vector each returned component comes
|
||||
/// from. For a component of a that is false, the
|
||||
/// corresponding component of x is returned. For a
|
||||
/// component of a that is true, the corresponding
|
||||
/// component of y is returned. Components of x and y that
|
||||
/// are not selected are allowed to be invalid floating point
|
||||
/// values and will have no effect on the results. Thus, this
|
||||
/// provides different functionality than
|
||||
/// genType mix(genType x, genType y, genType(a))
|
||||
/// where a is a Boolean vector.
|
||||
///
|
||||
/// @see <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/mix.xml">GLSL mix man page</a>
|
||||
/// @see <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.3 Common Functions</a>
|
||||
|
|
|
@ -41,16 +41,16 @@ namespace glm
|
|||
/// @addtogroup core_func_exponential
|
||||
/// @{
|
||||
|
||||
/// Returns x raised to the y power.
|
||||
/// Returns 'base' raised to the power 'exponent'.
|
||||
///
|
||||
/// @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
|
||||
/// @param base Floating point value. pow function is defined for input values of x defined in the range (inf-, inf+) in the limit of the type precision.
|
||||
/// @param exponent Floating point value representing the 'exponent'.
|
||||
/// @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/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.2 Exponential Functions</a>
|
||||
template <typename genType>
|
||||
genType pow(genType const & x, genType const & y);
|
||||
genType pow(genType const & base, genType const & exponent);
|
||||
|
||||
/// Returns the natural exponentiation of x, i.e., e^x.
|
||||
///
|
||||
|
|
|
@ -34,40 +34,6 @@
|
|||
namespace glm{
|
||||
namespace detail
|
||||
{
|
||||
//template
|
||||
//<
|
||||
// typename T,
|
||||
// template <typename> class C,
|
||||
// template <typename> class R
|
||||
//>
|
||||
//struct matType
|
||||
//{
|
||||
// enum ctor{null};
|
||||
// typedef T value_type;
|
||||
// typedef std::size_t size_type;
|
||||
// typedef C<T> col_type;
|
||||
// typedef R<T> row_type;
|
||||
// static size_type const col_size;
|
||||
// static size_type const row_size;
|
||||
//};
|
||||
|
||||
//template
|
||||
//<
|
||||
// typename T,
|
||||
// template <typename> class C,
|
||||
// template <typename> class R
|
||||
//>
|
||||
//typename matType<T, C, R>::size_type const
|
||||
//matType<T, C, R>::col_size = matType<T, C, R>::col_type::value_size;
|
||||
|
||||
//template
|
||||
//<
|
||||
// typename T,
|
||||
// template <typename> class C,
|
||||
// template <typename> class R
|
||||
//>
|
||||
//typename matType<T, C, R>::size_type const
|
||||
//matType<T, C, R>::row_size = matType<T, C, R>::row_type::value_size;
|
||||
|
||||
}//namespace detail
|
||||
}//namespace glm
|
||||
|
|
|
@ -37,7 +37,7 @@ More informations in GLM manual:
|
|||
http://glm.g-truc.net/glm.pdf
|
||||
|
||||
================================================================================
|
||||
GLM 0.9.4.2: 2013-01-XX
|
||||
GLM 0.9.4.2: 2013-02-14
|
||||
--------------------------------------------------------------------------------
|
||||
- Fixed compAdd from GTX_component_wise
|
||||
- Fixed SIMD support for Intel compiler on Windows
|
||||
|
@ -48,6 +48,7 @@ GLM 0.9.4.2: 2013-01-XX
|
|||
- Fixed mix for vec4 SSE implementation
|
||||
- Fixed 0x2013 dash character in comments that cause issue in Windows
|
||||
Japanese mode
|
||||
- Fixed documentation warnings
|
||||
|
||||
================================================================================
|
||||
GLM 0.9.4.1: 2012-12-22
|
||||
|
|
Loading…
Add table
Reference in a new issue