From 8e3e3ac6d32a3d5507d99b1f8ac5079e6550cfff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Thu, 22 Nov 2012 14:35:47 +0100 Subject: [PATCH] Doc++ --- src/Context.h | 31 ++++++++++++++++++++++++------- src/Math/Vector.h | 5 ++--- 2 files changed, 26 insertions(+), 10 deletions(-) diff --git a/src/Context.h b/src/Context.h index b9def93a4..5704762ab 100644 --- a/src/Context.h +++ b/src/Context.h @@ -144,19 +144,34 @@ class MAGNUM_EXPORT Context { /** @brief Current context */ inline static Context* current() { return _current; } - /** @brief OpenGL version */ + /** + * @brief OpenGL version + * + * @see majorVersion(), minorVersion(), versionString(), + * shadingLanguageVersionString() + */ inline Version version() const { return _version; } - /** @brief Major OpenGL version (e.g. `4`) */ + /** + * @brief Major OpenGL version (e.g. `4`) + * + * @see minorVersion(), version(), versionString(), + * shadingLanguageVersionString() + */ inline GLint majorVersion() const { return _majorVersion; } - /** @brief Minor OpenGL version (e.g. `3`) */ + /** + * @brief Minor OpenGL version (e.g. `3`) + * + * @see majorVersion(), version(), versionString(), + * shadingLanguageVersionString() + */ inline GLint minorVersion() const { return _minorVersion; } /** * @brief Vendor string * - * @see @fn_gl{GetString} with @def_gl{VENDOR} + * @see rendererString(), @fn_gl{GetString} with @def_gl{VENDOR} */ inline std::string vendorString() const { return reinterpret_cast(glGetString(GL_VENDOR)); @@ -165,7 +180,7 @@ class MAGNUM_EXPORT Context { /** * @brief Renderer string * - * @see @fn_gl{GetString} with @def_gl{RENDERER} + * @see vendorString(), @fn_gl{GetString} with @def_gl{RENDERER} */ inline std::string rendererString() const { return reinterpret_cast(glGetString(GL_RENDERER)); @@ -174,7 +189,8 @@ class MAGNUM_EXPORT Context { /** * @brief Version string * - * @see @fn_gl{GetString} with @def_gl{VERSION} + * @see shadingLanguageVersionString(), version(), @fn_gl{GetString} + * with @def_gl{VERSION} */ inline std::string versionString() const { return reinterpret_cast(glGetString(GL_VERSION)); @@ -183,7 +199,8 @@ class MAGNUM_EXPORT Context { /** * @brief Shading language version string * - * @see @fn_gl{GetString} with @def_gl{SHADING_LANGUAGE_VERSION} + * @see versionString(), version(), @fn_gl{GetString} with + * @def_gl{SHADING_LANGUAGE_VERSION} */ inline std::string shadingLanguageVersionString() const { return reinterpret_cast(glGetString(GL_SHADING_LANGUAGE_VERSION)); diff --git a/src/Math/Vector.h b/src/Math/Vector.h index a0304c49d..9fd4acba5 100644 --- a/src/Math/Vector.h +++ b/src/Math/Vector.h @@ -53,13 +53,12 @@ template class Vector: public RectangularMatrix<1, si } /** - * @brief Angle between normalized vectors + * @brief Angle between normalized vectors (in radians) * * @f[ * \phi = acos \left(\frac{a \cdot b}{|a| \cdot |b|} \right) * @f] - * @attention Assertion fails on non-normalized vectors and NaN is - * returned. + * @attention Both vectors must be normalized. */ inline static T angle(const Vector& normalizedA, const Vector& normalizedB) { CORRADE_ASSERT(MathTypeTraits::equals(normalizedA.dot(), T(1)) && MathTypeTraits::equals(normalizedB.dot(), T(1)),