Browse Source

Platform: doc++

pull/434/head
Vladimír Vondruš 6 years ago
parent
commit
3de507594d
  1. 6
      src/Magnum/Platform/AbstractXApplication.h
  2. 6
      src/Magnum/Platform/GlfwApplication.h

6
src/Magnum/Platform/AbstractXApplication.h

@ -110,7 +110,8 @@ class AbstractXApplication {
* @brief Execute main loop * @brief Execute main loop
* @return Value for returning from @cpp main() @ce * @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. * @ref MAGNUM_XEGLAPPLICATION_MAIN() for usage information.
*/ */
int exec(); int exec();
@ -124,7 +125,8 @@ class AbstractXApplication {
* Called internally from @ref exec(). If you want to have better * Called internally from @ref exec(). If you want to have better
* control over how the main loop behaves, you can call this function * control over how the main loop behaves, you can call this function
* yourself from your own `main()` function instead of it being called * 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(); bool mainLoopIteration();

6
src/Magnum/Platform/GlfwApplication.h

@ -243,7 +243,9 @@ class GlfwApplication {
* @brief Execute main loop * @brief Execute main loop
* @return Value for returning from @cpp main() @ce * @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(); int exec();
@ -256,7 +258,7 @@ class GlfwApplication {
* Called internally from @ref exec(). If you want to have better * Called internally from @ref exec(). If you want to have better
* control over how the main loop behaves, you can call this function * control over how the main loop behaves, you can call this function
* yourself from your own `main()` function instead of it being called * 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(); bool mainLoopIteration();

Loading…
Cancel
Save