Browse Source

Platform: improve docs of MAGNUM_*APPLICATION_MAIN() for consistency.

pull/190/head
Vladimír Vondruš 9 years ago
parent
commit
fa0395bb9e
  1. 5
      src/Magnum/Platform/Sdl2Application.h
  2. 13
      src/Magnum/Platform/WindowlessEglApplication.h
  3. 13
      src/Magnum/Platform/WindowlessIosApplication.h
  4. 13
      src/Magnum/Platform/WindowlessWglApplication.h
  5. 15
      src/Magnum/Platform/WindowlessWindowsEglApplication.h

5
src/Magnum/Platform/Sdl2Application.h

@ -1601,8 +1601,9 @@ class Sdl2Application::TextEditingEvent {
See @ref Magnum::Platform::Sdl2Application "Platform::Sdl2Application" for
usage information. This macro abstracts out platform-specific entry point code
and is equivalent to the following, see @ref portability-applications for more
information.
and is equivalent to the following on all supported platforms except
@ref CORRADE_TARGET_WINDOWS_RT "Windows RT", see @ref portability-applications
for more information.
@code
int main(int argc, char** argv) {
className app({argc, argv});

13
src/Magnum/Platform/WindowlessEglApplication.h

@ -331,9 +331,16 @@ class WindowlessEglApplication {
See @ref Magnum::Platform::WindowlessEglApplication "Platform::WindowlessEglApplication"
for usage information. This macro abstracts out platform-specific entry point
code, see @ref portability-applications for more information. When no other
windowless application header is included this macro is also aliased to
`MAGNUM_WINDOWLESSAPPLICATION_MAIN()`.
code and is equivalent to the following, see @ref portability-applications for
more information.
@code
int main(int argc, char** argv) {
className app({argc, argv});
return app.exec();
}
@endcode
When no other windowless application header is included this macro is also
aliased to `MAGNUM_WINDOWLESSAPPLICATION_MAIN()`.
*/
#define MAGNUM_WINDOWLESSEGLAPPLICATION_MAIN(className) \
int main(int argc, char** argv) { \

13
src/Magnum/Platform/WindowlessIosApplication.h

@ -289,9 +289,16 @@ class WindowlessIosApplication {
See @ref Magnum::Platform::WindowlessIosApplication "Platform::WindowlessIosApplication"
for usage information. This macro abstracts out platform-specific entry point
code, see @ref portability-applications for more information. When no other
windowless application header is included this macro is also aliased to
`MAGNUM_WINDOWLESSAPPLICATION_MAIN()`.
code and is equivalent to the following, see @ref portability-applications for
more information.
@code
int main(int argc, char** argv) {
className app({argc, argv});
return app.exec();
}
@endcode
When no other windowless application header is included this macro is also
aliased to `MAGNUM_WINDOWLESSAPPLICATION_MAIN()`.
*/
#define MAGNUM_WINDOWLESSIOSAPPLICATION_MAIN(className) \
int main(int argc, char** argv) { \

13
src/Magnum/Platform/WindowlessWglApplication.h

@ -343,9 +343,16 @@ class WindowlessWglApplication {
See @ref Magnum::Platform::WindowlessWglApplication "Platform::WindowlessWglApplication"
for usage information. This macro abstracts out platform-specific entry point
code, see @ref portability-applications for more information. When no other
windowless application header is included this macro is also aliased to
`MAGNUM_WINDOWLESSAPPLICATION_MAIN()`.
code and is equivalent to the following, see @ref portability-applications for
more information.
@code
int main(int argc, char** argv) {
className app({argc, argv});
return app.exec();
}
@endcode
When no other windowless application header is included this macro is also
aliased to `MAGNUM_WINDOWLESSAPPLICATION_MAIN()`.
*/
#define MAGNUM_WINDOWLESSWGLAPPLICATION_MAIN(className) \
int main(int argc, char** argv) { \

15
src/Magnum/Platform/WindowlessWindowsEglApplication.h

@ -327,10 +327,17 @@ class WindowlessWindowsEglApplication {
@param className Class name
See @ref Magnum::Platform::WindowlessWindowsEglApplication "Platform::WindowlessWindowsEglApplication"
for usage information. This macro abstracts out platform-specific entry point
code, see @ref portability-applications for more information. When no other
windowless application header is included this macro is also aliased to
`MAGNUM_WINDOWLESSAPPLICATION_MAIN()`.
for usage information.This macro abstracts out platform-specific entry point
code and is equivalent to the following, see @ref portability-applications for
more information.
@code
int main(int argc, char** argv) {
className app({argc, argv});
return app.exec();
}
@endcode
When no other windowless application header is included this macro is also
aliased to `MAGNUM_WINDOWLESSAPPLICATION_MAIN()`.
*/
#define MAGNUM_WINDOWLESSWINDOWSEGLAPPLICATION_MAIN(className) \
int main(int argc, char** argv) { \

Loading…
Cancel
Save