Browse Source

Doxygen command @todoc for documentation-related todos.

pull/279/head
Vladimír Vondruš 14 years ago
parent
commit
05ed802975
  1. 1
      Doxyfile
  2. 7
      src/BufferedTexture.h
  3. 21
      src/Math/Matrix.h
  4. 24
      src/Math/Vector.h
  5. 7
      src/Renderbuffer.h

1
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\"" \

7
src/BufferedTexture.h

@ -93,8 +93,11 @@ class BufferedTexture {
/** @copydoc AbstractTexture::InternalFormat::InternalFormat(AbstractTexture::Format) */
inline constexpr InternalFormat(Format format): internalFormat(static_cast<GLenum>(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:

21
src/Math/Matrix.h

@ -61,7 +61,11 @@ template<size_t size, class T> class Matrix {
return *reinterpret_cast<Matrix<size, T>*>(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<size, T>& from(const T* data) {
return *reinterpret_cast<const Matrix<size, T>*>(data);
}
@ -107,6 +111,7 @@ template<size_t size, class T> 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<class ...U> inline constexpr Matrix(T first, U... next): _data{first, next...} {
@ -128,14 +133,24 @@ template<size_t size, class T> 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<size, T>& operator[](size_t col) {
return Vector<size, T>::from(_data+col*size);
}
/** @copybrief operator[]() @copydetails operator[]() */
/**
* @copybrief operator[]()
* @copydetails operator[]()
* @todoc Remove workaround when Doxygen supports \@copydoc again
*/
inline constexpr const Vector<size, T>& operator[](size_t col) const {
return Vector<size, T>::from(_data+col*size);
}

24
src/Math/Vector.h

@ -48,7 +48,11 @@ template<size_t size, class T> class Vector {
return *reinterpret_cast<Vector<size, T>*>(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<size, T>& from(const T* data) {
return *reinterpret_cast<const Vector<size, T>*>(data);
}
@ -89,6 +93,8 @@ template<size_t size, class T> 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<class ...U> inline constexpr Vector(T first, U... next): _data{first, next...} {
@ -118,11 +124,23 @@ template<size_t size, class T> 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<size, T>& other) const {

7
src/Renderbuffer.h

@ -93,8 +93,11 @@ class Renderbuffer {
/** @copydoc AbstractTexture::InternalFormat::InternalFormat(AbstractTexture::Format) */
inline constexpr InternalFormat(Format format): internalFormat(static_cast<GLenum>(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:

Loading…
Cancel
Save