Fixed API documentation references and filenames

This commit is contained in:
Christophe Riccio 2018-08-28 21:55:47 +02:00
parent b52c256622
commit 37504928bb
37 changed files with 52 additions and 64 deletions

View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/matrix_dmat2x2_precision.hpp
/// @file glm/ext/matrix_double2x2_precision.hpp
#pragma once
#include "../detail/type_mat2x2.hpp"

View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/matrix_dmat2x3_precision.hpp
/// @file glm/ext/matrix_double2x3_precision.hpp
#pragma once
#include "../detail/type_mat2x3.hpp"

View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/matrix_dmat2x4_precision.hpp
/// @file glm/ext/matrix_double2x4_precision.hpp
#pragma once
#include "../detail/type_mat2x4.hpp"

View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/matrix_dmat3x2_precision.hpp
/// @file glm/ext/matrix_double3x2_precision.hpp
#pragma once
#include "../detail/type_mat3x2.hpp"

View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/matrix_dmat3x3_precision.hpp
/// @file glm/ext/matrix_double3x3_precision.hpp
#pragma once
#include "../detail/type_mat3x3.hpp"

View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/matrix_dmat3x4_precision.hpp
/// @file glm/ext/matrix_double3x4_precision.hpp
#pragma once
#include "../detail/type_mat3x4.hpp"

View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/matrix_dmat4x2_precision.hpp
/// @file glm/ext/matrix_double4x2_precision.hpp
#pragma once
#include "../detail/type_mat4x2.hpp"

View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/matrix_dmat4x3_precision.hpp
/// @file glm/ext/matrix_double4x3_precision.hpp
#pragma once
#include "../detail/type_mat4x3.hpp"

View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/matrix_dmat4x4_precision.hpp
/// @file glm/ext/matrix_double4x4_precision.hpp
#pragma once
#include "../detail/type_mat4x4.hpp"

View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/matrix_mat2x2_precision.hpp
/// @file glm/ext/matrix_float2x2_precision.hpp
#pragma once
#include "../detail/type_mat2x2.hpp"

View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/matrix_mat2x3_precision.hpp
/// @file glm/ext/matrix_float2x3_precision.hpp
#pragma once
#include "../detail/type_mat2x3.hpp"

View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/matrix_mat2x4_precision.hpp
/// @file glm/ext/matrix_float2x4_precision.hpp
#pragma once
#include "../detail/type_mat2x4.hpp"

View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/matrix_mat3x2_precision.hpp
/// @file glm/ext/matrix_float3x2_precision.hpp
#pragma once
#include "../detail/type_mat3x2.hpp"

View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/matrix_mat3x3_precision.hpp
/// @file glm/ext/matrix_float3x3_precision.hpp
#pragma once
#include "../detail/type_mat3x3.hpp"

View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/matrix_mat3x4_precision.hpp
/// @file glm/ext/matrix_float3x4_precision.hpp
#pragma once
#include "../detail/type_mat3x4.hpp"

View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/matrix_mat2x2_precision.hpp
/// @file glm/ext/matrix_float2x2_precision.hpp
#pragma once
#include "../detail/type_mat2x2.hpp"

View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/matrix_mat4x3_precision.hpp
/// @file glm/ext/matrix_float4x3_precision.hpp
#pragma once
#include "../detail/type_mat4x3.hpp"

View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/matrix_mat4x4_precision.hpp
/// @file glm/ext/matrix_float4x4_precision.hpp
#pragma once
#include "../detail/type_mat4x4.hpp"

View File

@ -3,7 +3,7 @@
///
/// @see core (dependence)
///
/// @defgroup ext_vector_relational GLM_EXT_matrix_relational
/// @defgroup ext_matrix_relational GLM_EXT_matrix_relational
/// @ingroup ext
///
/// Include <glm/ext/matrix_relational.hpp> to use the features of this extension.

View File

@ -3,7 +3,7 @@
///
/// @see core (dependence)
///
/// @defgroup ext_vector_relational GLM_EXT_scalar_relational
/// @defgroup ext_scalar_relational GLM_EXT_scalar_relational
/// @ingroup ext
///
/// Include <glm/ext/scalar_relational.hpp> to use the features of this extension.
@ -26,7 +26,7 @@ namespace glm
///
/// @tparam genType Floating-point or integer scalar types
///
/// @see ext_vector_relational
/// @see ext_scalar_relational
template<typename genType>
GLM_FUNC_DECL GLM_CONSTEXPR bool equal(genType const& x, genType const& y, genType const& epsilon);
@ -35,7 +35,7 @@ namespace glm
///
/// @tparam genType Floating-point or integer scalar types
///
/// @see ext_vector_relational
/// @see ext_scalar_relational
template<typename genType>
GLM_FUNC_DECL GLM_CONSTEXPR bool notEqual(genType const& x, genType const& y, genType const& epsilon);

View File

@ -1,7 +1,3 @@
/// @ref ext_scalar_relational
/// @file glm/ext/scalar_relational.inl
// Dependency:
#include "../common.hpp"
namespace glm

View File

@ -1,4 +1,4 @@
/// @ref ext_vector_bvec1
/// @ref ext_vector_bool1
/// @file glm/ext/vector_bool1.hpp
///
/// @see core (dependence)
@ -6,7 +6,7 @@
/// @defgroup ext_vector_bool1 GLM_EXT_vector_bool1
/// @ingroup ext
///
/// Include <glm/ext/vector_bvec1.hpp> to use the features of this extension.
/// Include <glm/ext/vector_bool1.hpp> to use the features of this extension.
///
/// Exposes bvec1 vector type.
@ -25,7 +25,7 @@ namespace glm
/// 1 components vector of boolean.
///
/// @see ext_vector_bvec1 extension.
/// @see ext_vector_bool1 extension.
typedef vec<1, bool, defaultp> bvec1;
/// @}

View File

@ -1,12 +1,12 @@
/// @ref ext_vector_bvec1_precision
/// @file glm/ext/vector_bvec1_precision.hpp
/// @ref ext_vector_bool1_precision
/// @file glm/ext/vector_bool1_precision.hpp
///
/// @see core (dependence)
///
/// @defgroup ext_vector_bvec1_precision GLM_EXT_vector_bvec1_precision
/// @defgroup ext_vector_bool1_precision GLM_EXT_vector_bool1_precision
/// @ingroup ext
///
/// Include <glm/ext/vector_bvec1_precision.hpp> to use the features of this extension.
/// Include <glm/ext/vector_bool1_precision.hpp> to use the features of this extension.
///
/// Exposes highp_bvec1, mediump_bvec1 and lowp_bvec1 types.
@ -15,27 +15,27 @@
#include "../detail/type_vec1.hpp"
#if GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)
# pragma message("GLM: GLM_EXT_vector_bvec1_precision extension included")
# pragma message("GLM: GLM_EXT_vector_bool1_precision extension included")
#endif
namespace glm
{
/// @addtogroup ext_vector_bvec1_precision
/// @addtogroup ext_vector_bool1_precision
/// @{
/// 1 component vector of bool values.
///
/// @see ext_vector_bvec1_precision
/// @see ext_vector_bool1_precision
typedef vec<1, bool, highp> highp_bvec1;
/// 1 component vector of bool values.
///
/// @see ext_vector_bvec1_precision
/// @see ext_vector_bool1_precision
typedef vec<1, bool, mediump> mediump_bvec1;
/// 1 component vector of bool values.
///
/// @see ext_vector_bvec1_precision
/// @see ext_vector_bool1_precision
typedef vec<1, bool, lowp> lowp_bvec1;
/// @}

View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/bvec2_precision.hpp
/// @file glm/ext/vector_bool2_precision.hpp
#pragma once
#include "../detail/type_vec2.hpp"

View File

@ -1,8 +1,7 @@
/// @ref core
/// @file glm/bvec3_precision.hpp
/// @file glm/ext/vector_bool3_precision.hpp
#pragma once
#include "../detail/setup.hpp"
#include "../detail/type_vec3.hpp"
namespace glm
@ -11,25 +10,22 @@ namespace glm
/// @{
/// 3 components vector of high qualifier bool numbers.
/// There is no guarantee on the actual qualifier.
///
/// @see <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 4.1.5 Vectors</a>
/// @see <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 4.7.2 Precision Qualifier</a>
typedef vec<3, bool, highp> highp_bvec3;
/// 3 components vector of medium qualifier bool numbers.
/// There is no guarantee on the actual qualifier.
///
/// @see <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 4.1.5 Vectors</a>
/// @see <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 4.7.2 Precision Qualifier</a>
typedef vec<3, bool, mediump> mediump_bvec3;
/// 3 components vector of low qualifier bool numbers.
/// There is no guarantee on the actual qualifier.
///
/// @see <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 4.1.5 Vectors</a>
/// @see <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 4.7.2 Precision Qualifier</a>
typedef vec<3, bool, lowp> lowp_bvec3;
/// @}
/// @}
}//namespace glm

View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/bvec4_precision.hpp
/// @file glm/ext/vector_bool4_precision.hpp
#pragma once
#include "../detail/type_vec4.hpp"

View File

@ -3,7 +3,7 @@
///
/// @see core (dependence)
///
/// @defgroup ext_vector_dvec1 GLM_EXT_vector_double1
/// @defgroup ext_vector_double1 GLM_EXT_vector_double1
/// @ingroup ext
///
/// Include <glm/ext/vector_double1.hpp> to use the features of this extension.
@ -20,12 +20,12 @@
namespace glm
{
/// @addtogroup ext_vector_dvec1
/// @addtogroup ext_vector_double1
/// @{
/// 1 components vector of double-precision floating-point numbers.
///
/// @see ext_vector_dvec1 extension.
/// @see ext_vector_double1 extension.
typedef vec<1, double, defaultp> dvec1;
/// @}

View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/vector_double2_precision.hpp
/// @file glm/ext/vector_double2_precision.hpp
#pragma once
#include "../detail/type_vec2.hpp"

View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/vector_double3_precision.hpp
/// @file glm/ext/vector_double3_precision.hpp
#pragma once
#include "../detail/type_vec3.hpp"

View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/vector_double4_precision.hpp
/// @file glm/ext/vector_double4_precision.hpp
#pragma once
#include "../detail/setup.hpp"

View File

@ -1,8 +1,7 @@
/// @ref core
/// @file glm/vector_float3_precision.hpp
/// @file glm/ext/vector_float3_precision.hpp
#pragma once
#include "../detail/setup.hpp"
#include "../detail/type_vec3.hpp"
namespace glm

View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/vector_float4_precision.hpp
/// @file glm/ext/vector_float4_precision.hpp
#pragma once
#include "../detail/type_vec4.hpp"

View File

@ -1,8 +1,7 @@
/// @ref core
/// @file glm/vector_int2_precision.hpp
/// @file glm/ext/vector_int2_precision.hpp
#pragma once
#include "../detail/setup.hpp"
#include "../detail/type_vec2.hpp"
namespace glm

View File

@ -1,8 +1,7 @@
/// @ref core
/// @file glm/vector_int3_precision.hpp
/// @file glm/ext/vector_int3_precision.hpp
#pragma once
#include "../detail/setup.hpp"
#include "../detail/type_vec3.hpp"
namespace glm

View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/vector_int4_precision.hpp
/// @file glm/ext/vector_int4_precision.hpp
#pragma once
#include "../detail/type_vec4.hpp"

View File

@ -25,17 +25,17 @@ namespace glm
/// 1 component vector of unsigned integer values.
///
/// @see ext_vec1
/// @see ext_vector_uint1_precision
typedef vec<1, unsigned int, highp> highp_uvec1;
/// 1 component vector of unsigned integer values.
///
/// @see ext_vec1
/// @see ext_vector_uint1_precision
typedef vec<1, unsigned int, mediump> mediump_uvec1;
/// 1 component vector of unsigned integer values.
///
/// @see ext_vec1
/// @see ext_vector_uint1_precision
typedef vec<1, unsigned int, lowp> lowp_uvec1;
/// @}

View File

@ -2,7 +2,6 @@
/// @file glm/ext/vector_uint3_precision.hpp
#pragma once
#include "../detail/setup.hpp"
#include "../detail/type_vec3.hpp"
namespace glm