ic
/
magnum
mirror of https://github.com/mosra/magnum.git
6
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Doxygen, FFS.

pull/432/head
Vladimír Vondruš 6 years ago
parent
8085ebba09
commit
081dd8981f
19 changed files with 291 additions and 59 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 6
      src/Magnum/Audio/AbstractImporter.h
  2. 12
      src/Magnum/Audio/Renderer.h
  3. 24
      src/Magnum/Audio/Source.h
  4. 68
      src/Magnum/GL/Renderer.h
  5. 18
      src/Magnum/Magnum.h
  6. 18
      src/Magnum/Math/Functions.h
  7. 6
      src/Magnum/Math/FunctionsBatch.h
  8. 6
      src/Magnum/Math/Packing.h
  9. 6
      src/Magnum/Math/PackingBatch.h
  10. 18
      src/Magnum/Platform/AbstractXApplication.h
  11. 12
      src/Magnum/Platform/AndroidApplication.h
  12. 24
      src/Magnum/Platform/EmscriptenApplication.h
  13. 30
      src/Magnum/Platform/GlfwApplication.h
  14. 24
      src/Magnum/Platform/Screen.h
  15. 36
      src/Magnum/Platform/Sdl2Application.h
  16. 6
      src/Magnum/SceneGraph/AbstractFeature.h
  17. 12
      src/Magnum/SceneGraph/AbstractObject.h
  18. 18
      src/Magnum/SceneGraph/Object.h
  19. 6
      src/Magnum/Trade/AbstractImporter.h

6
src/Magnum/Audio/AbstractImporter.h
Unescape View File

@ -196,7 +196,11 @@ class MAGNUM_AUDIO_EXPORT AbstractImporter: public PluginManager::AbstractManagi
/** @brief Sample data */
Containers::Array<char> data();
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
private:
/** @brief Implementation for @ref features() */

12
src/Magnum/Audio/Renderer.h
Unescape View File

@ -152,7 +152,11 @@ class Renderer {
alListeneriv(AL_VELOCITY, velocity.data());
}
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/** @{ @name Global behavior */
@ -265,7 +269,11 @@ class Renderer {
alDistanceModel(ALenum(model));
}
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
};
/** @debugoperatorclassenum{Renderer,Renderer::Error} */

24
src/Magnum/Audio/Source.h
Unescape View File

@ -171,7 +171,11 @@ class MAGNUM_AUDIO_EXPORT Source {
return *this;
}
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/** @{ @name Source behavior */
@ -474,7 +478,11 @@ class MAGNUM_AUDIO_EXPORT Source {
return *this;
}
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/** @{ @name Buffer management */
@ -534,7 +542,11 @@ class MAGNUM_AUDIO_EXPORT Source {
*/
std::size_t unqueueBuffers(Containers::ArrayView<Containers::Reference<Buffer>> buffers);
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/** @{ @name State management */
@ -742,7 +754,11 @@ class MAGNUM_AUDIO_EXPORT Source {
return *this;
}
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
private:
ALuint _id;

68
src/Magnum/GL/Renderer.h
Unescape View File

@ -450,7 +450,11 @@ class MAGNUM_GL_EXPORT Renderer {
*/
static void setHint(Hint target, HintMode mode);
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/** @{ @name Clearing values */
@ -515,9 +519,13 @@ class MAGNUM_GL_EXPORT Renderer {
*/
static void setClearStencil(Int stencil);
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/** @name Polygon drawing settings */
/** @{ @name Polygon drawing settings */
/**
* @brief Front facing polygon winding
@ -748,7 +756,11 @@ class MAGNUM_GL_EXPORT Renderer {
static void setPatchDefaultOuterLevel(const Vector4& levels);
#endif
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/** @{ @name Scissor operations */
@ -760,7 +772,11 @@ class MAGNUM_GL_EXPORT Renderer {
*/
static void setScissor(const Range2Di& rectangle);
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/** @{ @name Stencil operations */
@ -878,7 +894,11 @@ class MAGNUM_GL_EXPORT Renderer {
*/
static void setStencilOperation(StencilOperation stencilFail, StencilOperation depthFail, StencilOperation depthPass);
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/** @{ @name Depth testing */
@ -897,7 +917,11 @@ class MAGNUM_GL_EXPORT Renderer {
*/
static void setDepthFunction(DepthFunction function);
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/** @{ @name Masking writes */
@ -967,7 +991,11 @@ class MAGNUM_GL_EXPORT Renderer {
*/
static void setStencilMask(UnsignedInt allowBits);
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/**
* @{ @name Blending
@ -1501,7 +1529,11 @@ class MAGNUM_GL_EXPORT Renderer {
static void blendBarrier() { glBlendBarrierKHR(); }
#endif
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
#ifndef MAGNUM_TARGET_GLES
/** @{ @name Logical operation */
@ -1542,7 +1574,11 @@ class MAGNUM_GL_EXPORT Renderer {
*/
static void setLogicOperation(LogicOperation operation);
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
#endif
/** @{ @name Renderer synchronization */
@ -1692,7 +1728,11 @@ class MAGNUM_GL_EXPORT Renderer {
}
#endif
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/** @{ @name Renderer management */
@ -1894,7 +1934,11 @@ class MAGNUM_GL_EXPORT Renderer {
static GraphicsResetStatus graphicsResetStatus();
#endif
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
private:
static void MAGNUM_GL_LOCAL initializeContextBasedFunctionality();

18
src/Magnum/Magnum.h
Unescape View File

@ -807,7 +807,11 @@ typedef Math::Range3D<Int> Range3Di;
/** @brief Float frustum */
typedef Math::Frustum<Float> Frustum;
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work anymore.
FFS. */
/**
* @}
*/
/** @{ @name Half-precision types
@ -913,7 +917,11 @@ typedef Math::Matrix4x3<Half> Matrix4x3h;
*/
typedef Math::Matrix4x4<Half> Matrix4x4h;
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work anymore.
FFS. */
/**
* @}
*/
/** @{ @name Double-precision types
@ -1104,7 +1112,11 @@ typedef Math::Range3D<Double> Range3Dd;
/** @brief Double frustum */
typedef Math::Frustum<Double> Frustumd;
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work anymore.
FFS. */
/**
* @}
*/
#ifndef DOXYGEN_GENERATING_OUTPUT
template<UnsignedInt, class T> class Array;

18
src/Magnum/Math/Functions.h
Unescape View File

@ -173,7 +173,11 @@ template<class T> inline Rad<T> acos(T value) { return Rad<T>(std::acos(value));
/** @brief Arc tangent */
template<class T> inline Rad<T> atan(T value) { return Rad<T>(std::atan(value)); }
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work anymore.
FFS. */
/**
* @}
*/
/**
@{ @name Scalar/vector functions
@ -536,7 +540,11 @@ template<std::size_t size, class T> inline Vector<size, T> fma(const Vector<size
return a*b + c;
}
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work anymore.
FFS. */
/**
* @}
*/
/**
@{ @name Exponential and power functions
@ -706,7 +714,11 @@ template<std::size_t size, class T> inline Vector<size, T> refract(const Vector<
return eta*vector - (eta*dot + std::sqrt(k))*normal;
}
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work anymore.
FFS. */
/**
* @}
*/
}}

6
src/Magnum/Math/FunctionsBatch.h
Unescape View File

@ -343,7 +343,11 @@ template<class T, std::size_t size> inline std::pair<T, T> minmax(const T(&array
return minmax<T>(Corrade::Containers::StridedArrayView1D<const T>{array});
}
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work anymore.
FFS. */
/**
* @}
*/
}}

6
src/Magnum/Math/Packing.h
Unescape View File

@ -217,7 +217,11 @@ template<std::size_t size> Vector<size, Float> unpackHalf(const Vector<size, Uns
return out;
}
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work anymore.
FFS. */
/**
* @}
*/
}}

6
src/Magnum/Math/PackingBatch.h
Unescape View File

@ -324,7 +324,11 @@ MAGNUM_EXPORT void castInto(const Corrade::Containers::StridedArrayView2D<const
*/
MAGNUM_EXPORT void castInto(const Corrade::Containers::StridedArrayView2D<const Int>& src, const Corrade::Containers::StridedArrayView2D<Byte>& dst);
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work anymore.
FFS. */
/**
* @}
*/
}}

18
src/Magnum/Platform/AbstractXApplication.h
Unescape View File

@ -242,7 +242,11 @@ class AbstractXApplication {
/** @copydoc Sdl2Application::drawEvent() */
virtual void drawEvent() = 0;
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/** @{ @name Keyboard handling */
@ -252,7 +256,11 @@ class AbstractXApplication {
/** @copydoc Sdl2Application::keyReleaseEvent() */
virtual void keyReleaseEvent(KeyEvent& event);
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/** @{ @name Mouse handling */
@ -265,7 +273,11 @@ class AbstractXApplication {
/** @copydoc Sdl2Application::mouseMoveEvent() */
virtual void mouseMoveEvent(MouseMoveEvent& event);
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
#ifdef DOXYGEN_GENERATING_OUTPUT
private:

12
src/Magnum/Platform/AndroidApplication.h
Unescape View File

@ -385,7 +385,11 @@ class AndroidApplication {
/** @copydoc Sdl2Application::drawEvent() */
virtual void drawEvent() = 0;
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/** @{ @name Mouse handling */
@ -413,7 +417,11 @@ class AndroidApplication {
*/
virtual void mouseMoveEvent(MouseMoveEvent& event);
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
private:
struct LogOutput;

24
src/Magnum/Platform/EmscriptenApplication.h
Unescape View File

@ -532,7 +532,11 @@ class EmscriptenApplication {
/** @copydoc Sdl2Application::drawEvent() */
virtual void drawEvent() = 0;
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/** @{ @name Keyboard handling */
@ -542,7 +546,11 @@ class EmscriptenApplication {
/** @copydoc Sdl2Application::keyReleaseEvent() */
virtual void keyReleaseEvent(KeyEvent& event);
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/** @{ @name Mouse handling */
@ -782,7 +790,11 @@ class EmscriptenApplication {
*/
virtual void mouseScrollEvent(MouseScrollEvent& event);
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/** @{ @name Text input handling */
public:
@ -836,7 +848,11 @@ class EmscriptenApplication {
*/
virtual void textInputEvent(TextInputEvent& event);
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
private:
enum class Flag: UnsignedByte {

30
src/Magnum/Platform/GlfwApplication.h
Unescape View File

@ -537,7 +537,11 @@ class GlfwApplication {
/** @copydoc Sdl2Application::drawEvent() */
virtual void drawEvent() = 0;
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/** @{ @name Keyboard handling */
@ -547,7 +551,11 @@ class GlfwApplication {
/** @copydoc Sdl2Application::keyReleaseEvent() */
virtual void keyReleaseEvent(KeyEvent& event);
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/** @{ @name Mouse handling */
@ -643,7 +651,11 @@ class GlfwApplication {
/** @copydoc Sdl2Application::mouseScrollEvent() */
virtual void mouseScrollEvent(MouseScrollEvent& event);
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/** @{ @name Text input handling */
public:
@ -682,7 +694,11 @@ class GlfwApplication {
*/
virtual void textInputEvent(TextInputEvent& event);
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/** @{ @name Special events */
@ -697,7 +713,11 @@ class GlfwApplication {
*/
virtual void exitEvent(ExitEvent& event);
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
private:
enum class Flag: UnsignedByte;

24
src/Magnum/Platform/Screen.h
Unescape View File

@ -376,7 +376,11 @@ template<class Application> class BasicScreen:
*/
virtual void drawEvent() = 0;
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/** @{ @name Keyboard handling */
@ -402,7 +406,11 @@ template<class Application> class BasicScreen:
virtual void keyReleaseEvent(KeyEvent& event);
#endif
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/** @{ @name Mouse handling */
@ -446,7 +454,11 @@ template<class Application> class BasicScreen:
virtual void mouseScrollEvent(MouseScrollEvent& event);
#endif
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/** @{ @name Text input handling */
@ -472,7 +484,11 @@ template<class Application> class BasicScreen:
virtual void textEditingEvent(TextEditingEvent& event);
#endif
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
private:
#ifndef DOXYGEN_GENERATING_OUTPUT /* https://bugzilla.gnome.org/show_bug.cgi?id=776986 */

36
src/Magnum/Platform/Sdl2Application.h
Unescape View File

@ -890,7 +890,11 @@ class Sdl2Application {
*/
virtual void drawEvent() = 0;
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/** @{ @name Keyboard handling */
@ -908,7 +912,11 @@ class Sdl2Application {
*/
virtual void keyReleaseEvent(KeyEvent& event);
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/** @{ @name Mouse handling */
@ -1020,7 +1028,11 @@ class Sdl2Application {
*/
virtual void mouseScrollEvent(MouseScrollEvent& event);
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/** @{ @name Touch gesture handling */
@ -1033,7 +1045,11 @@ class Sdl2Application {
*/
virtual void multiGestureEvent(MultiGestureEvent& event);
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/** @{ @name Text input handling */
public:
@ -1093,7 +1109,11 @@ class Sdl2Application {
*/
virtual void textEditingEvent(TextEditingEvent& event);
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/** @{ @name Special events */
@ -1141,7 +1161,11 @@ class Sdl2Application {
*/
virtual void anyEvent(SDL_Event& event);
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
private:
enum class Flag: UnsignedByte;

6
src/Magnum/SceneGraph/AbstractFeature.h
Unescape View File

@ -264,7 +264,11 @@ template<UnsignedInt dimensions, class T> class AbstractFeature
*/
virtual void cleanInverted(const MatrixTypeFor<dimensions, T>& invertedAbsoluteTransformationMatrix);
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
private:
#ifndef DOXYGEN_GENERATING_OUTPUT /* https://bugzilla.gnome.org/show_bug.cgi?id=776986 */

12
src/Magnum/SceneGraph/AbstractObject.h
Unescape View File

@ -181,7 +181,11 @@ template<UnsignedInt dimensions, class T> class AbstractObject
return doTransformationMatrices(objects, finalTransformationMatrix);
}
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/**
* @{ @name Transformation caching
@ -240,7 +244,11 @@ template<UnsignedInt dimensions, class T> class AbstractObject
*/
void setClean() { doSetClean(); }
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
private:
#ifndef DOXYGEN_GENERATING_OUTPUT /* https://bugzilla.gnome.org/show_bug.cgi?id=776986 */

18
src/Magnum/SceneGraph/Object.h
Unescape View File

@ -219,7 +219,11 @@ template<class Transformation> class Object: public AbstractObject<Transformatio
*/
Object<Transformation>& setParentKeepTransformation(Object<Transformation>* parent);
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/** @{ @name Object transformation */
@ -279,7 +283,11 @@ template<class Transformation> class Object: public AbstractObject<Transformatio
#endif
) const;
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/**
* @{ @name Transformation caching
@ -319,7 +327,11 @@ template<class Transformation> class Object: public AbstractObject<Transformatio
/* note: doc verbatim copied from AbstractObject::setClean() */
void setClean();
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
#ifndef DOXYGEN_GENERATING_OUTPUT
public:

6
src/Magnum/Trade/AbstractImporter.h
Unescape View File

@ -1198,7 +1198,11 @@ class MAGNUM_TRADE_EXPORT AbstractImporter: public PluginManager::AbstractManagi
*/
Containers::Optional<ImageData3D> image3D(const std::string& name, UnsignedInt level = 0);
/*@}*/
/* Since 1.8.17, the original short-hand group closing doesn't work
anymore. FFS. */
/**
* @}
*/
/**
* @brief Plugin-specific access to internal importer state

Write Preview
Loading…
Cancel
Save