From 3de507594d123fbf69dac98779c532c6865bf7a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Thu, 9 Apr 2020 16:15:36 +0200 Subject: [PATCH] Platform: doc++ --- src/Magnum/Platform/AbstractXApplication.h | 6 ++++-- src/Magnum/Platform/GlfwApplication.h | 6 ++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/src/Magnum/Platform/AbstractXApplication.h b/src/Magnum/Platform/AbstractXApplication.h index 7cffc83d7..1a065027a 100644 --- a/src/Magnum/Platform/AbstractXApplication.h +++ b/src/Magnum/Platform/AbstractXApplication.h @@ -110,7 +110,8 @@ class AbstractXApplication { * @brief Execute main loop * @return Value for returning from @cpp main() @ce * - * See @ref MAGNUM_GLXAPPLICATION_MAIN() or + * Calls @ref mainLoopIteration() in a loop until @ref exit() is + * called. See @ref MAGNUM_GLXAPPLICATION_MAIN() or * @ref MAGNUM_XEGLAPPLICATION_MAIN() for usage information. */ int exec(); @@ -124,7 +125,8 @@ class AbstractXApplication { * Called internally from @ref exec(). If you want to have better * control over how the main loop behaves, you can call this function * yourself from your own `main()` function instead of it being called - * automatically from @ref exec(). + * automatically from @ref exec() / @ref MAGNUM_GLXAPPLICATION_MAIN() + * / @ref MAGNUM_XEGLAPPLICATION_MAIN(). */ bool mainLoopIteration(); diff --git a/src/Magnum/Platform/GlfwApplication.h b/src/Magnum/Platform/GlfwApplication.h index bbb5e2f55..5b6f2e4ab 100644 --- a/src/Magnum/Platform/GlfwApplication.h +++ b/src/Magnum/Platform/GlfwApplication.h @@ -243,7 +243,9 @@ class GlfwApplication { * @brief Execute main loop * @return Value for returning from @cpp main() @ce * - * See @ref MAGNUM_GLFWAPPLICATION_MAIN() for usage information. + * Calls @ref mainLoopIteration() in a loop until @ref exit() is + * called. See @ref MAGNUM_GLFWAPPLICATION_MAIN() for usage + * information. */ int exec(); @@ -256,7 +258,7 @@ class GlfwApplication { * Called internally from @ref exec(). If you want to have better * control over how the main loop behaves, you can call this function * yourself from your own `main()` function instead of it being called - * automatically from @ref exec(). + * automatically from @ref exec() / @ref MAGNUM_GLFWAPPLICATION_MAIN(). */ bool mainLoopIteration();