Browse Source

Doc++

Not documenting private implementation, in fact hiding it from user
altogether.
pull/279/head
Vladimír Vondruš 14 years ago
parent
commit
ed74f579fa
  1. 4
      doc/namespaces.dox
  2. 2
      src/Framebuffer.h
  3. 9
      src/Math/Matrix.h
  4. 2
      src/Renderbuffer.h

4
doc/namespaces.dox

@ -15,7 +15,3 @@ Basic primitives for testing purposes.
Collection of shaders for testing purposes. Collection of shaders for testing purposes.
*/ */
/** @namespace Magnum::Math::Implementation
@brief Internal math implementation
*/

2
src/Framebuffer.h

@ -27,7 +27,7 @@
namespace Magnum { namespace Magnum {
/** /**
@brief Framebuffer @brief %Framebuffer
*/ */
class MAGNUM_EXPORT Framebuffer { class MAGNUM_EXPORT Framebuffer {
Framebuffer(const Framebuffer& other) = delete; Framebuffer(const Framebuffer& other) = delete;

9
src/Math/Matrix.h

@ -23,10 +23,10 @@
namespace Magnum { namespace Math { namespace Magnum { namespace Math {
#ifndef DOXYGEN_GENERATING_OUTPUT
namespace Implementation { namespace Implementation {
template<class T, size_t size> class MatrixDeterminant; template<class T, size_t size> class MatrixDeterminant;
#ifndef DOXYGEN_GENERATING_OUTPUT
template<size_t ...> struct Sequence {}; template<size_t ...> struct Sequence {};
template<size_t N, size_t ...S> struct GenerateSequence: template<size_t N, size_t ...S> struct GenerateSequence:
@ -35,8 +35,8 @@ namespace Implementation {
template<size_t ...S> struct GenerateSequence<0, S...> { template<size_t ...S> struct GenerateSequence<0, S...> {
typedef Sequence<S...> Type; typedef Sequence<S...> Type;
}; };
#endif
} }
#endif
/** /**
* @brief %Matrix * @brief %Matrix
@ -220,9 +220,9 @@ template<class T, size_t size> class Matrix {
T _data[size*size]; T _data[size*size];
}; };
#ifndef DOXYGEN_GENERATING_OUTPUT
namespace Implementation { namespace Implementation {
/** @brief Matrix determinant implementation for >2x2 matrices */
template<class T, size_t size> class MatrixDeterminant { template<class T, size_t size> class MatrixDeterminant {
public: public:
/** @brief Functor */ /** @brief Functor */
@ -236,7 +236,6 @@ template<class T, size_t size> class MatrixDeterminant {
} }
}; };
/** @brief Matrix determinant implementation for 2x2 matrix */
template<class T> class MatrixDeterminant<T, 2> { template<class T> class MatrixDeterminant<T, 2> {
public: public:
/** @brief Functor */ /** @brief Functor */
@ -245,7 +244,6 @@ template<class T> class MatrixDeterminant<T, 2> {
} }
}; };
/** @brief Matrix determinant implementation for 1x1 matrix */
template<class T> class MatrixDeterminant<T, 1> { template<class T> class MatrixDeterminant<T, 1> {
public: public:
/** @brief Functor */ /** @brief Functor */
@ -256,7 +254,6 @@ template<class T> class MatrixDeterminant<T, 1> {
} }
#ifndef DOXYGEN_GENERATING_OUTPUT
template<class T, size_t size> Corrade::Utility::Debug operator<<(Corrade::Utility::Debug debug, const Magnum::Math::Matrix<T, size>& value) { template<class T, size_t size> Corrade::Utility::Debug operator<<(Corrade::Utility::Debug debug, const Magnum::Math::Matrix<T, size>& value) {
debug << "Matrix("; debug << "Matrix(";
debug.setFlag(Corrade::Utility::Debug::SpaceAfterEachValue, false); debug.setFlag(Corrade::Utility::Debug::SpaceAfterEachValue, false);

2
src/Renderbuffer.h

@ -24,7 +24,7 @@
namespace Magnum { namespace Magnum {
/** /**
@brief Renderbuffer @brief %Renderbuffer
Attachable to Framebuffer as render target. Attachable to Framebuffer as render target.
*/ */

Loading…
Cancel
Save