diff --git a/src/Magnum/Platform/AndroidApplication.h b/src/Magnum/Platform/AndroidApplication.h index 47a914cb8..2c20b326e 100644 --- a/src/Magnum/Platform/AndroidApplication.h +++ b/src/Magnum/Platform/AndroidApplication.h @@ -189,7 +189,7 @@ class AndroidApplication { #endif /** - * @brief Construct with given configuration for OpenGL context + * @brief Construct with an OpenGL context * @param arguments Application arguments * @param configuration Application configuration * @param glConfiguration OpenGL context configuration @@ -202,20 +202,17 @@ class AndroidApplication { explicit AndroidApplication(const Arguments& arguments, const Configuration& configuration, const GLConfiguration& glConfiguration); /** - * @brief Construct with given configuration + * @brief Construct without explicit GPU context configuration * * Equivalent to calling @ref AndroidApplication(const Arguments&, const Configuration&, const GLConfiguration&) * with default-constructed @ref GLConfiguration. */ + #ifdef DOXYGEN_GENERATING_OUTPUT + explicit AndroidApplication(const Arguments& arguments, const Configuration& configuration = Configuration{}); + #else explicit AndroidApplication(const Arguments& arguments, const Configuration& configuration); - - /** - * @brief Construct with default configuration - * - * Equivalent to calling @ref AndroidApplication(const Arguments&, const Configuration&) - * with default-constructed @ref Configuration. - */ explicit AndroidApplication(const Arguments& arguments); + #endif /** * @brief Construct without creating a window diff --git a/src/Magnum/Platform/EmscriptenApplication.h b/src/Magnum/Platform/EmscriptenApplication.h index 92605426e..7f41f8242 100644 --- a/src/Magnum/Platform/EmscriptenApplication.h +++ b/src/Magnum/Platform/EmscriptenApplication.h @@ -302,7 +302,7 @@ class EmscriptenApplication { #ifdef MAGNUM_TARGET_GL /** - * @brief Construct with given configuration for WebGL context + * @brief Construct with a WebGL context * @param arguments Application arguments * @param configuration Application configuration * @param glConfiguration WebGL context configuration @@ -320,7 +320,7 @@ class EmscriptenApplication { #endif /** - * @brief Construct with given configuration + * @brief Construct without explicit GPU context configuration * * If @ref Configuration::WindowFlag::Contextless is present or Magnum * was not built with @ref MAGNUM_TARGET_GL, this creates a window @@ -333,15 +333,13 @@ class EmscriptenApplication { * * See also @ref building-features for more information. */ + #ifdef DOXYGEN_GENERATING_OUTPUT + explicit EmscriptenApplication(const Arguments& arguments, const Configuration& configuration = Configuration{}); + #else + /* Configuration is only forward-declared at this point */ explicit EmscriptenApplication(const Arguments& arguments, const Configuration& configuration); - - /** - * @brief Construct with default configuration - * - * Equivalent to calling @ref EmscriptenApplication(const Arguments&, const Configuration&) - * with default-constructed @ref Configuration. - */ explicit EmscriptenApplication(const Arguments& arguments); + #endif /** * @brief Construct without setting up a canvas @@ -1215,7 +1213,6 @@ class EmscriptenApplication::Configuration { enum class WindowFlag: UnsignedShort { /** * Do not create any GPU context. Use together with - * @ref EmscriptenApplication(const Arguments&), * @ref EmscriptenApplication(const Arguments&, const Configuration&), * @ref create(const Configuration&) or * @ref tryCreate(const Configuration&) to prevent implicit diff --git a/src/Magnum/Platform/GlfwApplication.h b/src/Magnum/Platform/GlfwApplication.h index f788d8881..70519d035 100644 --- a/src/Magnum/Platform/GlfwApplication.h +++ b/src/Magnum/Platform/GlfwApplication.h @@ -185,7 +185,7 @@ class GlfwApplication { #ifdef MAGNUM_TARGET_GL /** - * @brief Construct with given configuration for OpenGL context + * @brief Construct with an OpenGL context * @param arguments Application arguments * @param configuration Application configuration * @param glConfiguration OpenGL context configuration @@ -203,7 +203,7 @@ class GlfwApplication { #endif /** - * @brief Construct with given configuration + * @brief Construct without explicit GPU context configuration * * If @ref Configuration::WindowFlag::Contextless is present or Magnum * was not built with @ref MAGNUM_TARGET_GL, this creates a window @@ -216,15 +216,13 @@ class GlfwApplication { * * See also @ref building-features for more information. */ + #ifdef DOXYGEN_GENERATING_OUTPUT + explicit GlfwApplication(const Arguments& arguments, const Configuration& configuration = Configuration{}); + #else + /* Configuration is only forward-declared at this point */ explicit GlfwApplication(const Arguments& arguments, const Configuration& configuration); - - /** - * @brief Construct with default configuration - * - * Equivalent to calling @ref GlfwApplication(const Arguments&, const Configuration&) - * with default-constructed @ref Configuration. - */ explicit GlfwApplication(const Arguments& arguments); + #endif /** * @brief Construct without creating a window @@ -1112,7 +1110,6 @@ class GlfwApplication::Configuration { #if defined(DOXYGEN_GENERATING_OUTPUT) || defined(GLFW_NO_API) /** * Do not create any GPU context. Use together with - * @ref GlfwApplication(const Arguments&), * @ref GlfwApplication(const Arguments&, const Configuration&), * @ref create(const Configuration&) or * @ref tryCreate(const Configuration&) to prevent implicit diff --git a/src/Magnum/Platform/GlxApplication.h b/src/Magnum/Platform/GlxApplication.h index e9ececfc1..d1d5f88e4 100644 --- a/src/Magnum/Platform/GlxApplication.h +++ b/src/Magnum/Platform/GlxApplication.h @@ -100,7 +100,7 @@ If no other application header is included, this class is also aliased to class GlxApplication: public AbstractXApplication { public: /** - * @brief Construct with given configuration for OpenGL context + * @brief Construct with an OpenGL context * @param arguments Application arguments * @param configuration Application configuration * @param glConfiguration OpenGL context configuration diff --git a/src/Magnum/Platform/Sdl2Application.h b/src/Magnum/Platform/Sdl2Application.h index bc1a95c61..fd2c6ac5a 100644 --- a/src/Magnum/Platform/Sdl2Application.h +++ b/src/Magnum/Platform/Sdl2Application.h @@ -508,7 +508,7 @@ class Sdl2Application { #ifdef MAGNUM_TARGET_GL /** - * @brief Construct with given configuration for OpenGL context + * @brief Construct with an OpenGL context * @param arguments Application arguments * @param configuration Application configuration * @param glConfiguration OpenGL context configuration @@ -526,7 +526,7 @@ class Sdl2Application { #endif /** - * @brief Construct with given configuration + * @brief Construct without explicit GPU context configuration * * If @ref Configuration::WindowFlag::Contextless is present or Magnum * was not built with @ref MAGNUM_TARGET_GL, this creates a window @@ -539,15 +539,13 @@ class Sdl2Application { * * See also @ref building-features for more information. */ + #ifdef DOXYGEN_GENERATING_OUTPUT + explicit Sdl2Application(const Arguments& arguments, const Configuration& configuration = Configuration{}); + #else + /* Configuration is only forward-declared at this point */ explicit Sdl2Application(const Arguments& arguments, const Configuration& configuration); - - /** - * @brief Construct with default configuration - * - * Equivalent to calling @ref Sdl2Application(const Arguments&, const Configuration&) - * with default-constructed @ref Configuration. - */ explicit Sdl2Application(const Arguments& arguments); + #endif /** * @brief Construct without creating a window @@ -1735,7 +1733,7 @@ class Sdl2Application::Configuration { /** * Request a window for use with OpenGL. Useful in combination with * @ref WindowFlag::Contextless, otherwise enabled implicitly when - * creating an OpenGL context using @ref Sdl2Application(const Arguments&), + * creating an OpenGL context using * @ref Sdl2Application(const Arguments&, const Configuration&, const GLConfiguration&), * @ref create(const Configuration&, const GLConfiguration&) or * @ref tryCreate(const Configuration&, const GLConfiguration&). diff --git a/src/Magnum/Platform/XEglApplication.h b/src/Magnum/Platform/XEglApplication.h index 53cbfc067..7feb6af0e 100644 --- a/src/Magnum/Platform/XEglApplication.h +++ b/src/Magnum/Platform/XEglApplication.h @@ -104,7 +104,7 @@ If no other application header is included, this class is also aliased to class XEglApplication: public AbstractXApplication { public: /** - * @brief Construct with given configuration for OpenGL context + * @brief Construct with an OpenGL context * @param arguments Application arguments * @param configuration Application configuration * @param glConfiguration OpenGL context configuration