From 05ed802975d7a4477108799099ae31abd0e3184f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Tue, 22 May 2012 13:28:07 +0200 Subject: [PATCH] Doxygen command @todoc for documentation-related todos. --- Doxyfile | 1 + src/BufferedTexture.h | 7 +++++-- src/Math/Matrix.h | 21 ++++++++++++++++++--- src/Math/Vector.h | 24 +++++++++++++++++++++--- src/Renderbuffer.h | 7 +++++-- 5 files changed, 50 insertions(+), 10 deletions(-) diff --git a/Doxyfile b/Doxyfile index e8ba945f8..37134745f 100644 --- a/Doxyfile +++ b/Doxyfile @@ -194,6 +194,7 @@ TAB_SIZE = 8 # You can put \n's in the value part of an alias to insert newlines. ALIASES = \ + "todoc=@xrefitem todox \"Documentation todo\" \"Documentation-related todo list\"" \ "requires_gl30=@xrefitem RequiresGL30 \"Requires OpenGL 3.0\" \"Functionality requiring OpenGL 3.0\"" \ "requires_gl31=@xrefitem RequiresGL31 \"Requires OpenGL 3.1\" \"Functionality requiring OpenGL 3.1\"" \ "requires_gl32=@xrefitem RequiresGL32 \"Requires OpenGL 3.2\" \"Functionality requiring OpenGL 3.2\"" \ diff --git a/src/BufferedTexture.h b/src/BufferedTexture.h index d4ee3a939..e17ad6f6d 100644 --- a/src/BufferedTexture.h +++ b/src/BufferedTexture.h @@ -93,8 +93,11 @@ class BufferedTexture { /** @copydoc AbstractTexture::InternalFormat::InternalFormat(AbstractTexture::Format) */ inline constexpr InternalFormat(Format format): internalFormat(static_cast(format)) {} - /** @brief OpenGL internal format ID */ - /* doxygen: @copydoc AbstractTexture::InternalFormat::operator GLint() doesn't work */ + /** + * @brief OpenGL internal format ID + * + * @todoc Remove workaround when Doxygen supports \@copydoc for conversion operators + */ inline constexpr operator GLint() const { return internalFormat; } private: diff --git a/src/Math/Matrix.h b/src/Math/Matrix.h index d9dabbd3f..f265d309b 100644 --- a/src/Math/Matrix.h +++ b/src/Math/Matrix.h @@ -61,7 +61,11 @@ template class Matrix { return *reinterpret_cast*>(data); } - /** @copybrief from(T*) @copydetails from(T*) */ + /** + * @copybrief from(T*) + * @copydetails from(T*) + * @todoc Remove workaround when Doxygen supports \@copydoc again + */ inline constexpr static const Matrix& from(const T* data) { return *reinterpret_cast*>(data); } @@ -107,6 +111,7 @@ template class Matrix { * @param next Next values * * Note that the values are in column-major order. + * @todoc Remove workaround when Doxygen supports uniform initialization */ #ifndef DOXYGEN_GENERATING_OUTPUT template inline constexpr Matrix(T first, U... next): _data{first, next...} { @@ -128,14 +133,24 @@ template class Matrix { * order. */ inline T* data() { return _data; } - inline constexpr const T* data() const { return _data; } /**< @copybrief data() @copydetails data() */ + + /** + * @copybrief data() + * @copydetails data() + * @todoc Remove workaround when Doxygen supports \@copydoc again + */ + inline constexpr const T* data() const { return _data; } /** @brief %Matrix column */ inline Vector& operator[](size_t col) { return Vector::from(_data+col*size); } - /** @copybrief operator[]() @copydetails operator[]() */ + /** + * @copybrief operator[]() + * @copydetails operator[]() + * @todoc Remove workaround when Doxygen supports \@copydoc again + */ inline constexpr const Vector& operator[](size_t col) const { return Vector::from(_data+col*size); } diff --git a/src/Math/Vector.h b/src/Math/Vector.h index 56eb0c60b..46a2dc8b2 100644 --- a/src/Math/Vector.h +++ b/src/Math/Vector.h @@ -48,7 +48,11 @@ template class Vector { return *reinterpret_cast*>(data); } - /** @copybrief from(T*) @copydetails from(T*) */ + /** + * @copybrief from(T*) + * @copydetails from(T*) + * @todoc Remove workaround when Doxygen supports \@copydoc again + */ inline constexpr static const Vector& from(const T* data) { return *reinterpret_cast*>(data); } @@ -89,6 +93,8 @@ template class Vector { * @brief Initializer-list constructor * @param first First value * @param next Next values + * + * @todoc Remove workaround when Doxygen supports uniform initialization */ #ifndef DOXYGEN_GENERATING_OUTPUT template inline constexpr Vector(T first, U... next): _data{first, next...} { @@ -118,11 +124,23 @@ template class Vector { * @return Array with the same size as the vector */ inline T* data() { return _data; } - inline constexpr const T* data() const { return _data; } /**< @copybrief data() @copydetails data() */ + + /** + * @copybrief data() + * @copydetails data() + * @todoc Remove workaround when Doxygen supports \@copydoc again + */ + inline constexpr const T* data() const { return _data; } /** @brief Value at given position */ inline T& operator[](size_t pos) { return _data[pos]; } - inline constexpr T operator[](size_t pos) const { return _data[pos]; } /**< @copybrief operator[]() @copydetails operator[]() */ + + /** + * @copybrief operator[]() + * @copydetails operator[]() + * @todoc Remove workaround when Doxygen supports \@copydoc again + */ + inline constexpr T operator[](size_t pos) const { return _data[pos]; } /** @brief Equality operator */ inline bool operator==(const Vector& other) const { diff --git a/src/Renderbuffer.h b/src/Renderbuffer.h index 5a18fb621..8d6970e8c 100644 --- a/src/Renderbuffer.h +++ b/src/Renderbuffer.h @@ -93,8 +93,11 @@ class Renderbuffer { /** @copydoc AbstractTexture::InternalFormat::InternalFormat(AbstractTexture::Format) */ inline constexpr InternalFormat(Format format): internalFormat(static_cast(format)) {} - /** @brief OpenGL internal format ID */ - /* doxygen: @copydoc AbstractTexture::InternalFormat::operator GLint() doesn't work */ + /** + * @brief OpenGL internal format ID + * + * @todoc Remove workaround when Doxygen supports \@copydoc for conversion operators + */ inline constexpr operator GLenum() const { return internalFormat; } private: