Browse Source

Doc: some workarounds for Doxygen C++11 support etc.

pull/279/head
Vladimír Vondruš 14 years ago
parent
commit
05107f383b
  1. 7
      src/BufferedImage.h
  2. 10
      src/Image.h
  3. 4
      src/Math/Matrix.h
  4. 9
      src/Math/Matrix3.h
  5. 9
      src/Math/Matrix4.h
  6. 4
      src/Math/Vector.h
  7. 4
      src/Primitives/Icosphere.h
  8. 8
      src/SizeTraits.h

7
src/BufferedImage.h

@ -116,7 +116,12 @@ typedef BufferedImage<1> BufferedImage1D;
/** @brief Two-dimensional buffered image */ /** @brief Two-dimensional buffered image */
class MAGNUM_EXPORT BufferedImage2D: public BufferedImage<2> { class MAGNUM_EXPORT BufferedImage2D: public BufferedImage<2> {
public: public:
/** @copydoc BufferedImage::BufferedImage */ /**
* @brief Constructor
* @param colorFormat Color format of the data.
* @param type Data type per color channel
*/
/* doxygen: @copydoc BufferedImage::BufferedImage doesn't work */
inline BufferedImage2D(AbstractTexture::ColorFormat colorFormat, Type type): BufferedImage(colorFormat, type) {} inline BufferedImage2D(AbstractTexture::ColorFormat colorFormat, Type type): BufferedImage(colorFormat, type) {}
/** /**

10
src/Image.h

@ -121,7 +121,15 @@ typedef Image<1> Image1D;
/** @brief Two-dimensional image */ /** @brief Two-dimensional image */
class MAGNUM_EXPORT Image2D: public Image<2> { class MAGNUM_EXPORT Image2D: public Image<2> {
public: public:
/** @copydoc Image::Image */ /**
* @brief Constructor
* @param colorFormat Color format of passed data
* @param type Data type per color channel
*
* Dimensions and data pointer are are set to zero, call
* setDimensions() and setData() to fill the image with data.
*/
/* doxygen: @copydoc Image::Image doesn't work */
inline Image2D(AbstractTexture::ColorFormat colorFormat, Type type): Image(colorFormat, type) {} inline Image2D(AbstractTexture::ColorFormat colorFormat, Type type): Image(colorFormat, type) {}
/** /**

4
src/Math/Matrix.h

@ -48,7 +48,11 @@ template<class T, size_t size> class Matrix {
* *
* Note that the values are in column-major order. * Note that the values are in column-major order.
*/ */
#ifndef DOXYGEN_GENERATING_OUTPUT
template<class ...U> inline Matrix(T first, U&&... next): _data{first, std::forward<U>(next)...} {} template<class ...U> inline Matrix(T first, U&&... next): _data{first, std::forward<U>(next)...} {}
#else
template<class ...U> inline Matrix(T first, U&&... next);
#endif
/** /**
* @brief Constructor * @brief Constructor

9
src/Math/Matrix3.h

@ -30,7 +30,14 @@ template<class T> class Matrix3: public Matrix<T, 3> {
/** @copydoc Matrix::Matrix(bool) */ /** @copydoc Matrix::Matrix(bool) */
inline Matrix3(bool identity = true): Matrix<T, 3>(identity) {} inline Matrix3(bool identity = true): Matrix<T, 3>(identity) {}
/** @copydoc Matrix::Matrix(T, U&&...) */ /**
* @brief Initializer-list constructor
* @param first First value
* @param next Next values
*
* Note that the values are in column-major order.
*/
/* doxygen: @copydoc Matrix::Matrix(T, U&&...) doesn't work */
template<class ...U> inline Matrix3(T first, U&&... next): Matrix<T, 3>(first, std::forward<U>(next)...) {} template<class ...U> inline Matrix3(T first, U&&... next): Matrix<T, 3>(first, std::forward<U>(next)...) {}
/** @copydoc Matrix::Matrix(const T*) */ /** @copydoc Matrix::Matrix(const T*) */

9
src/Math/Matrix4.h

@ -96,7 +96,14 @@ template<class T> class Matrix4: public Matrix<T, 4> {
/** @copydoc Matrix::Matrix(bool) */ /** @copydoc Matrix::Matrix(bool) */
inline Matrix4(bool identity = true): Matrix<T, 4>(identity) {} inline Matrix4(bool identity = true): Matrix<T, 4>(identity) {}
/** @copydoc Matrix::Matrix(T, U&&...) */ /**
* @brief Initializer-list constructor
* @param first First value
* @param next Next values
*
* Note that the values are in column-major order.
*/
/* doxygen: @copydoc Matrix::Matrix(T, U&&...) doesn't work */
template<class ...U> inline Matrix4(T first, U&&... next): Matrix<T, 4>(first, std::forward<U>(next)...) {} template<class ...U> inline Matrix4(T first, U&&... next): Matrix<T, 4>(first, std::forward<U>(next)...) {}
/** @copydoc Matrix::Matrix(const T*) */ /** @copydoc Matrix::Matrix(const T*) */

4
src/Math/Vector.h

@ -48,7 +48,11 @@ template<class T, size_t size> class Vector {
* @param first First value * @param first First value
* @param next Next values * @param next Next values
*/ */
#ifndef DOXYGEN_GENERATING_OUTPUT
template<class ...U> inline Vector(T first, U&&... next): _data{first, std::forward<U>(next)...} {} template<class ...U> inline Vector(T first, U&&... next): _data{first, std::forward<U>(next)...} {}
#else
template<class ...U> inline Vector(T first, U&&... next);
#endif
/** /**
* @brief Constructor * @brief Constructor

4
src/Primitives/Icosphere.h

@ -43,7 +43,11 @@ template<> class Icosphere<0>: public Trade::MeshData {
* @brief %Icosphere primitive * @brief %Icosphere primitive
* @tparam subdivisions Number of subdivisions * @tparam subdivisions Number of subdivisions
*/ */
#ifndef DOXYGEN_GENERATING_OUTPUT
template<size_t subdivisions> class Icosphere: public Icosphere<0> { template<size_t subdivisions> class Icosphere: public Icosphere<0> {
#else
template<size_t subdivisions> class Icosphere {
#endif
public: public:
/** @brief Constructor */ /** @brief Constructor */
Icosphere() { Icosphere() {

8
src/SizeTraits.h

@ -35,8 +35,8 @@ if you want to store 289 elements, they occupy two bytes, so
convenience you can use Log class to compute logarithms at compile time, e.g. convenience you can use Log class to compute logarithms at compile time, e.g.
<tt>%SizeTraits&lt;Log&lt;256, <strong>289</strong>&gt;::%value&gt;::%SizeType</tt>. <tt>%SizeTraits&lt;Log&lt;256, <strong>289</strong>&gt;::%value&gt;::%SizeType</tt>.
*/ */
template<size_t byte> struct SizeTraits: public SizeTraits<byte - 1> { #ifdef DOXYGEN_GENERATING_OUTPUT
#ifdef DOXYGEN_GENERATING_OUTPUT template<size_t byte> struct SizeTraits {
/** /**
* @brief (Unsigned) type able to index the data * @brief (Unsigned) type able to index the data
* *
@ -44,8 +44,10 @@ template<size_t byte> struct SizeTraits: public SizeTraits<byte - 1> {
* OpenGL doesn't have any type which would be able to store the indices. * OpenGL doesn't have any type which would be able to store the indices.
*/ */
typedef T SizeType; typedef T SizeType;
#endif
}; };
#else
template<size_t byte> struct SizeTraits: public SizeTraits<byte - 1> {};
#endif
#ifndef DOXYGEN_GENERATING_OUTPUT #ifndef DOXYGEN_GENERATING_OUTPUT
template<> struct SizeTraits<0> { template<> struct SizeTraits<0> {

Loading…
Cancel
Save