Browse Source

Exclude namespaces from forward declaration header docs.

They don't document anything, so there's no point in listing them.
pull/653/head
Vladimír Vondruš 2 years ago
parent
commit
d50dbe4e0c
  1. 4
      src/Magnum/Animation/Animation.h
  2. 4
      src/Magnum/Audio/Audio.h
  3. 4
      src/Magnum/DebugTools/DebugTools.h
  4. 4
      src/Magnum/GL/GL.h
  5. 4
      src/Magnum/Math/Math.h
  6. 4
      src/Magnum/Platform/Platform.h
  7. 4
      src/Magnum/SceneGraph/SceneGraph.h
  8. 4
      src/Magnum/ShaderTools/ShaderTools.h
  9. 4
      src/Magnum/Shaders/Shaders.h
  10. 4
      src/Magnum/Text/Text.h
  11. 4
      src/Magnum/TextureTools/TextureTools.h
  12. 4
      src/Magnum/Trade/Trade.h
  13. 6
      src/Magnum/Vk/Vk.h

4
src/Magnum/Animation/Animation.h

@ -32,9 +32,9 @@
#include "Magnum/Types.h" #include "Magnum/Types.h"
#ifndef DOXYGEN_GENERATING_OUTPUT
namespace Magnum { namespace Animation { namespace Magnum { namespace Animation {
#ifndef DOXYGEN_GENERATING_OUTPUT
namespace Implementation { namespace Implementation {
template<class V> struct ResultTraits; template<class V> struct ResultTraits;
template<class, class> struct TypeTraits; template<class, class> struct TypeTraits;
@ -50,8 +50,8 @@ template<class T, class K = T> class Player;
template<class K, class V, class R = ResultOf<V>> class Track; template<class K, class V, class R = ResultOf<V>> class Track;
template<class K> class TrackViewStorage; template<class K> class TrackViewStorage;
template<class K, class V, class R = ResultOf<V>> class TrackView; template<class K, class V, class R = ResultOf<V>> class TrackView;
#endif
}} }}
#endif
#endif #endif

4
src/Magnum/Audio/Audio.h

@ -34,11 +34,9 @@
#ifndef DOXYGEN_GENERATING_OUTPUT #ifndef DOXYGEN_GENERATING_OUTPUT
typedef int ALenum; typedef int ALenum;
#endif
namespace Magnum { namespace Audio { namespace Magnum { namespace Audio {
#ifndef DOXYGEN_GENERATING_OUTPUT
class AbstractImporter; class AbstractImporter;
enum class BufferFormat: ALenum; enum class BufferFormat: ALenum;
@ -59,8 +57,8 @@ typedef PlayableGroup<3> PlayableGroup3D;
template<UnsignedInt> class Listener; template<UnsignedInt> class Listener;
typedef Listener<2> Listener2D; typedef Listener<2> Listener2D;
typedef Listener<3> Listener3D; typedef Listener<3> Listener3D;
#endif
}} }}
#endif
#endif #endif

4
src/Magnum/DebugTools/DebugTools.h

@ -36,9 +36,9 @@
#include <Corrade/Utility/Macros.h> #include <Corrade/Utility/Macros.h>
#endif #endif
#ifndef DOXYGEN_GENERATING_OUTPUT
namespace Magnum { namespace DebugTools { namespace Magnum { namespace DebugTools {
#ifndef DOXYGEN_GENERATING_OUTPUT
#ifdef MAGNUM_BUILD_DEPRECATED #ifdef MAGNUM_BUILD_DEPRECATED
class CORRADE_DEPRECATED("use FrameProfiler instead") Profiler; class CORRADE_DEPRECATED("use FrameProfiler instead") Profiler;
#endif #endif
@ -62,8 +62,8 @@ class ObjectRendererOptions;
class ResourceManager; class ResourceManager;
#endif #endif
#endif
}} }}
#endif
#endif #endif

4
src/Magnum/GL/GL.h

@ -38,11 +38,9 @@
typedef int GLint; /* Needed for sampler enums */ typedef int GLint; /* Needed for sampler enums */
typedef unsigned int GLenum; /* Needed for *Format and *Type enums */ typedef unsigned int GLenum; /* Needed for *Format and *Type enums */
typedef unsigned int GLuint; /* Needed by Implementation/State.h */ typedef unsigned int GLuint; /* Needed by Implementation/State.h */
#endif
namespace Magnum { namespace GL { namespace Magnum { namespace GL {
#ifndef DOXYGEN_GENERATING_OUTPUT
namespace Implementation { namespace Implementation {
/* Needed by Context as well as all Implementation::*State classes */ /* Needed by Context as well as all Implementation::*State classes */
enum: std::size_t { enum: std::size_t {
@ -182,9 +180,9 @@ class TransformFeedback;
#endif #endif
enum class Version: Int; enum class Version: Int;
#endif
}} }}
#endif
#endif #endif

4
src/Magnum/Math/Math.h

@ -38,11 +38,11 @@
#include <Corrade/Utility/Macros.h> #include <Corrade/Utility/Macros.h>
#endif #endif
#ifndef DOXYGEN_GENERATING_OUTPUT
namespace Magnum { namespace Math { namespace Magnum { namespace Math {
/** @todo Denormals to zero */ /** @todo Denormals to zero */
#ifndef DOXYGEN_GENERATING_OUTPUT
template<std::size_t> class BitVector; template<std::size_t> class BitVector;
#ifdef MAGNUM_BUILD_DEPRECATED #ifdef MAGNUM_BUILD_DEPRECATED
template<std::size_t size> using BoolVector CORRADE_DEPRECATED_ALIAS("use BitVector instead") = BitVector<size>; template<std::size_t size> using BoolVector CORRADE_DEPRECATED_ALIAS("use BitVector instead") = BitVector<size>;
@ -120,8 +120,8 @@ namespace Implementation {
template<class> struct StrictWeakOrdering; template<class> struct StrictWeakOrdering;
} }
#endif #endif
#endif
}} }}
#endif
#endif #endif

4
src/Magnum/Platform/Platform.h

@ -32,9 +32,9 @@
#include "Magnum/configure.h" #include "Magnum/configure.h"
#ifndef DOXYGEN_GENERATING_OUTPUT
namespace Magnum { namespace Platform { namespace Magnum { namespace Platform {
#ifndef DOXYGEN_GENERATING_OUTPUT
template<class> class BasicScreen; template<class> class BasicScreen;
template<class> class BasicScreenedApplication; template<class> class BasicScreenedApplication;
/* For ScreenedApplication backwards compatibility with mouseScrollEvent() /* For ScreenedApplication backwards compatibility with mouseScrollEvent()
@ -50,8 +50,8 @@ class TwoFingerGesture;
#ifdef MAGNUM_TARGET_GL #ifdef MAGNUM_TARGET_GL
class GLContext; class GLContext;
#endif #endif
#endif
}} }}
#endif
#endif #endif

4
src/Magnum/SceneGraph/SceneGraph.h

@ -32,9 +32,9 @@
#include "Magnum/Types.h" #include "Magnum/Types.h"
#ifndef DOXYGEN_GENERATING_OUTPUT
namespace Magnum { namespace SceneGraph { namespace Magnum { namespace SceneGraph {
#ifndef DOXYGEN_GENERATING_OUTPUT
enum class AspectRatioPolicy: UnsignedByte; enum class AspectRatioPolicy: UnsignedByte;
/* Enum CachedTransformation and CachedTransformations used only directly */ /* Enum CachedTransformation and CachedTransformations used only directly */
@ -152,8 +152,8 @@ typedef BasicTranslationRotationScalingTransformation3D<Float> TranslationRotati
namespace Implementation { namespace Implementation {
template<class> struct Transformation; template<class> struct Transformation;
} }
#endif
}} }}
#endif
#endif #endif

4
src/Magnum/ShaderTools/ShaderTools.h

@ -33,13 +33,13 @@
#include "Magnum/Types.h" #include "Magnum/Types.h"
#ifndef DOXYGEN_GENERATING_OUTPUT
namespace Magnum { namespace ShaderTools { namespace Magnum { namespace ShaderTools {
#ifndef DOXYGEN_GENERATING_OUTPUT
class AbstractConverter; class AbstractConverter;
enum class Stage: UnsignedInt; enum class Stage: UnsignedInt;
#endif
}} }}
#endif
#endif #endif

4
src/Magnum/Shaders/Shaders.h

@ -36,9 +36,9 @@
#include <Corrade/Utility/Macros.h> #include <Corrade/Utility/Macros.h>
#endif #endif
#ifndef DOXYGEN_GENERATING_OUTPUT
namespace Magnum { namespace Shaders { namespace Magnum { namespace Shaders {
#ifndef DOXYGEN_GENERATING_OUTPUT
template<UnsignedInt> class DistanceFieldVectorGL; template<UnsignedInt> class DistanceFieldVectorGL;
typedef DistanceFieldVectorGL<2> DistanceFieldVectorGL2D; typedef DistanceFieldVectorGL<2> DistanceFieldVectorGL2D;
typedef DistanceFieldVectorGL<3> DistanceFieldVectorGL3D; typedef DistanceFieldVectorGL<3> DistanceFieldVectorGL3D;
@ -98,8 +98,8 @@ template<UnsignedInt dimensions> using VertexColor CORRADE_DEPRECATED_ALIAS("use
typedef CORRADE_DEPRECATED("use VertexColorGL2D instead") VertexColorGL2D VertexColor2D; typedef CORRADE_DEPRECATED("use VertexColorGL2D instead") VertexColorGL2D VertexColor2D;
typedef CORRADE_DEPRECATED("use VertexColorGL3D instead") VertexColorGL3D VertexColor3D; typedef CORRADE_DEPRECATED("use VertexColorGL3D instead") VertexColorGL3D VertexColor3D;
#endif #endif
#endif
}} }}
#endif
#endif #endif

4
src/Magnum/Text/Text.h

@ -36,9 +36,9 @@
#include <Corrade/Utility/Macros.h> #include <Corrade/Utility/Macros.h>
#endif #endif
#ifndef DOXYGEN_GENERATING_OUTPUT
namespace Magnum { namespace Text { namespace Magnum { namespace Text {
#ifndef DOXYGEN_GENERATING_OUTPUT
class AbstractFont; class AbstractFont;
class AbstractFontConverter; class AbstractFontConverter;
class AbstractGlyphCache; class AbstractGlyphCache;
@ -68,8 +68,8 @@ template<UnsignedInt> class Renderer;
typedef Renderer<2> Renderer2D; typedef Renderer<2> Renderer2D;
typedef Renderer<3> Renderer3D; typedef Renderer<3> Renderer3D;
#endif #endif
#endif
}} }}
#endif
#endif #endif

4
src/Magnum/TextureTools/TextureTools.h

@ -34,12 +34,12 @@
#include "Magnum/Magnum.h" #include "Magnum/Magnum.h"
#ifndef DOXYGEN_GENERATING_OUTPUT
namespace Magnum { namespace TextureTools { namespace Magnum { namespace TextureTools {
#ifndef DOXYGEN_GENERATING_OUTPUT
class AtlasLandfill; class AtlasLandfill;
#endif
}} }}
#endif
#endif #endif

4
src/Magnum/Trade/Trade.h

@ -38,9 +38,9 @@
#include <Corrade/Utility/Macros.h> #include <Corrade/Utility/Macros.h>
#endif #endif
#ifndef DOXYGEN_GENERATING_OUTPUT
namespace Magnum { namespace Trade { namespace Magnum { namespace Trade {
#ifndef DOXYGEN_GENERATING_OUTPUT
class AbstractImageConverter; class AbstractImageConverter;
class AbstractImporter; class AbstractImporter;
class AbstractSceneConverter; class AbstractSceneConverter;
@ -116,8 +116,8 @@ class SceneData;
template<UnsignedInt> class SkinData; template<UnsignedInt> class SkinData;
typedef SkinData<2> SkinData2D; typedef SkinData<2> SkinData2D;
typedef SkinData<3> SkinData3D; typedef SkinData<3> SkinData3D;
#endif
}} }}
#endif
#endif #endif

6
src/Magnum/Vk/Vk.h

@ -34,9 +34,9 @@
#include "Magnum/Magnum.h" #include "Magnum/Magnum.h"
#ifndef DOXYGEN_GENERATING_OUTPUT
namespace Magnum { namespace Vk { namespace Magnum { namespace Vk {
#ifndef DOXYGEN_GENERATING_OUTPUT
enum class Access: UnsignedInt; enum class Access: UnsignedInt;
typedef Containers::EnumSet<Access> Accesses; typedef Containers::EnumSet<Access> Accesses;
class Buffer; class Buffer;
@ -138,15 +138,15 @@ class ShaderSet;
enum class ShaderStage: UnsignedInt; enum class ShaderStage: UnsignedInt;
/* 0x7FFFFFFF = VK_SHADER_STAGE_ALL, but that would mean including the whole /* 0x7FFFFFFF = VK_SHADER_STAGE_ALL, but that would mean including the whole
Vulkan headers. Using a number here and then the actual enum value in Vulkan headers. Using a number here and then the actual enum value in
Shadder.h to ensure it doesn't get out of sync. */ Shader.h to ensure it doesn't get out of sync. */
typedef Containers::EnumSet<ShaderStage, 0x7FFFFFFF> ShaderStages; typedef Containers::EnumSet<ShaderStage, 0x7FFFFFFF> ShaderStages;
class SubmitInfo; class SubmitInfo;
class SubpassBeginInfo; class SubpassBeginInfo;
class SubpassEndInfo; class SubpassEndInfo;
enum class Version: UnsignedInt; enum class Version: UnsignedInt;
enum class VertexFormat: Int; enum class VertexFormat: Int;
#endif
}} }}
#endif
#endif #endif

Loading…
Cancel
Save