Platform: doc++

mosra · Apr 9, 2020 · 3de5075 · 3de5075
1 parent 492ba41
commit 3de5075
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git 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
@@ -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();