From ed74f579fae9fb0221de60e7472763ddf2f1ff7f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Tue, 17 Apr 2012 18:32:47 +0200 Subject: [PATCH] Doc++ Not documenting private implementation, in fact hiding it from user altogether. --- doc/namespaces.dox | 4 ---- src/Framebuffer.h | 2 +- src/Math/Matrix.h | 9 +++------ src/Renderbuffer.h | 2 +- 4 files changed, 5 insertions(+), 12 deletions(-) diff --git a/doc/namespaces.dox b/doc/namespaces.dox index 8e0adb2ca..4a7054097 100644 --- a/doc/namespaces.dox +++ b/doc/namespaces.dox @@ -15,7 +15,3 @@ Basic primitives for testing purposes. Collection of shaders for testing purposes. */ - -/** @namespace Magnum::Math::Implementation -@brief Internal math implementation -*/ diff --git a/src/Framebuffer.h b/src/Framebuffer.h index d1e642578..e80ca9cc6 100644 --- a/src/Framebuffer.h +++ b/src/Framebuffer.h @@ -27,7 +27,7 @@ namespace Magnum { /** -@brief Framebuffer +@brief %Framebuffer */ class MAGNUM_EXPORT Framebuffer { Framebuffer(const Framebuffer& other) = delete; diff --git a/src/Math/Matrix.h b/src/Math/Matrix.h index 639748a29..70363d9ab 100644 --- a/src/Math/Matrix.h +++ b/src/Math/Matrix.h @@ -23,10 +23,10 @@ namespace Magnum { namespace Math { +#ifndef DOXYGEN_GENERATING_OUTPUT namespace Implementation { template class MatrixDeterminant; - #ifndef DOXYGEN_GENERATING_OUTPUT template struct Sequence {}; template struct GenerateSequence: @@ -35,8 +35,8 @@ namespace Implementation { template struct GenerateSequence<0, S...> { typedef Sequence Type; }; - #endif } +#endif /** * @brief %Matrix @@ -220,9 +220,9 @@ template class Matrix { T _data[size*size]; }; +#ifndef DOXYGEN_GENERATING_OUTPUT namespace Implementation { -/** @brief Matrix determinant implementation for >2x2 matrices */ template class MatrixDeterminant { public: /** @brief Functor */ @@ -236,7 +236,6 @@ template class MatrixDeterminant { } }; -/** @brief Matrix determinant implementation for 2x2 matrix */ template class MatrixDeterminant { public: /** @brief Functor */ @@ -245,7 +244,6 @@ template class MatrixDeterminant { } }; -/** @brief Matrix determinant implementation for 1x1 matrix */ template class MatrixDeterminant { public: /** @brief Functor */ @@ -256,7 +254,6 @@ template class MatrixDeterminant { } -#ifndef DOXYGEN_GENERATING_OUTPUT template Corrade::Utility::Debug operator<<(Corrade::Utility::Debug debug, const Magnum::Math::Matrix& value) { debug << "Matrix("; debug.setFlag(Corrade::Utility::Debug::SpaceAfterEachValue, false); diff --git a/src/Renderbuffer.h b/src/Renderbuffer.h index 8602e45f3..7e5fd721b 100644 --- a/src/Renderbuffer.h +++ b/src/Renderbuffer.h @@ -24,7 +24,7 @@ namespace Magnum { /** -@brief Renderbuffer +@brief %Renderbuffer Attachable to Framebuffer as render target. */