Browse Source

doc: improved and unified docs for command-line utilities.

Especially mention how to build them and how to use them with CMake.
Also add a dedicated page for the Magnum::Ui Gallery.
pull/272/head
Vladimír Vondruš 8 years ago
parent
commit
8f6ca904d8
  1. 13
      doc/cmake.dox
  2. 35
      doc/namespaces.dox
  3. 12
      doc/utilities.dox
  4. 12
      src/Magnum/Audio/al-info.cpp
  5. 11
      src/Magnum/Platform/gl-info.cpp
  6. 11
      src/Magnum/Text/fontconverter.cpp
  7. 12
      src/Magnum/TextureTools/distancefieldconverter.cpp
  8. 11
      src/Magnum/Trade/imageconverter.cpp

13
doc/cmake.dox

@ -175,11 +175,14 @@ dependencies, you need to find the dependency and then link to it.
Lastly, a few utility executables are available: Lastly, a few utility executables are available:
- `distancefieldconverter` --- @ref magnum-distancefieldconverter executable - `distancefieldconverter` --- @ref magnum-distancefieldconverter "magnum-distancefieldconverter"
- `fontconverter` --- @ref magnum-fontconverter executable executable
- `imageconverter` --- @ref magnum-imageconverter executable - `fontconverter` --- @ref magnum-fontconverter "magnum-fontconverter"
- `gl-info` --- @ref magnum-gl-info executable executable
- `al-info` --- @ref magnum-al-info executable - `imageconverter` --- @ref magnum-imageconverter "magnum-imageconverter"
executable
- `gl-info` --- @ref magnum-gl-info "magnum-gl-info" executable
- `al-info` --- @ref magnum-al-info "magnum-al-info" executable
Note that [each namespace](namespaces.html), all @ref Platform libraries and Note that [each namespace](namespaces.html), all @ref Platform libraries and
each plugin class contain more detailed information about dependencies, each plugin class contain more detailed information about dependencies,

35
doc/namespaces.dox

@ -67,7 +67,8 @@ find_package(Magnum REQUIRED Sdl2Application)
target_link_libraries(your-app Magnum::Application) target_link_libraries(your-app Magnum::Application)
@endcode @endcode
See documentation of particular `*Application` classs, @ref building, See documentation of particular `*Application` classs, the
@ref magnum-gl-info "magnum-gl-info" utility documentation, @ref building,
@ref cmake and @ref platform for more information. @ref cmake and @ref platform for more information.
*/ */
@ -210,10 +211,9 @@ find_package(Magnum REQUIRED Audio)
target_link_libraries(your-app Magnum::Audio) target_link_libraries(your-app Magnum::Audio)
@endcode @endcode
See @ref building and @ref cmake for more information. Additional plugins and utilities are built separately. See particular
`Audio::*Importer` class documentation, the @ref magnum-al-info "magnum-al-info"
Additional plugins are built separately, see particular `Audio::*Importer` utility documentation, @ref building, @ref building-plugins, @ref cmake,
class documentation, @ref building, @ref building-plugins, @ref cmake,
@ref cmake-plugins and @ref plugins for more information. @ref cmake-plugins and @ref plugins for more information.
*/ */
@ -396,11 +396,11 @@ find_package(Magnum REQUIRED Text)
target_link_libraries(your-app Magnum::Text) target_link_libraries(your-app Magnum::Text)
@endcode @endcode
See @ref building and @ref cmake for more information. Additional plugins and utilities are built separately. See particular `*Font`
and `*FontConverter` class documentation, the
Additional plugins are built separately, see particular `*Font` and @ref magnum-fontconverter "magnum-fontconverter" utility documentation,
`*FontConverter` class documentation, @ref building, @ref building-plugins, @ref building, @ref building-plugins, @ref cmake, @ref cmake-plugins and
@ref cmake, @ref cmake-plugins and @ref plugins for more information. @ref plugins for more information.
*/ */
/** @dir Magnum/TextureTools /** @dir Magnum/TextureTools
@ -427,7 +427,9 @@ Note that functionality depending on @ref GL APIs is available only if Magnum
is built with both `WITH_GL` and `TARGET_GL` enabled (which is done by is built with both `WITH_GL` and `TARGET_GL` enabled (which is done by
default). default).
See @ref building and @ref cmake for more information. Additional utilities are built separately. See the
@ref magnum-distancefieldconverter "magnum-distancefieldconverter" utility
documentation, @ref building and @ref cmake for more information.
*/ */
/** @dir Magnum/Trade /** @dir Magnum/Trade
@ -450,12 +452,11 @@ find_package(Magnum REQUIRED Trade)
target_link_libraries(your-app Magnum::Trade) target_link_libraries(your-app Magnum::Trade)
@endcode @endcode
See @ref building and @ref cmake for more information. Additional plugins and utilities are built separately. See particular
`Trade::*Importer` and `*ImageConverter` class documentation, the
Additional plugins are built separately, see particular `Trade::*Importer` and @ref magnum-imageconverter "magnum-imageconverter" utility documentation,
`*ImageConverter` class documentation, @ref building, @ref building-plugins, @ref building, @ref building-plugins, @ref cmake, @ref cmake-plugins and
@ref cmake, @ref cmake-plugins and @ref plugins for more @ref plugins for more information.
information.
*/ */
/** @dir Magnum/Vk /** @dir Magnum/Vk

12
doc/utilities.dox

@ -25,13 +25,19 @@
namespace Magnum { namespace Magnum {
/** @page utilities Utilities /** @page utilities Utilities
@brief Command-line utilities for system information and data conversion @brief Utilities for system information, data conversion, multimedia apps
- @subpage magnum-gl-info --- @copybrief magnum-gl-info The following command-line utilities are available:
- @subpage magnum-al-info --- @copybrief magnum-al-info
- @subpage magnum-gl-info @m_class{m-label m-default m-flat} **live web demo** --- @copybrief magnum-gl-info
- @subpage magnum-al-info @m_class{m-label m-default m-flat} **live web demo** --- @copybrief magnum-al-info
- @subpage magnum-distancefieldconverter --- @copybrief magnum-distancefieldconverter - @subpage magnum-distancefieldconverter --- @copybrief magnum-distancefieldconverter
- @subpage magnum-fontconverter --- @copybrief magnum-fontconverter - @subpage magnum-fontconverter --- @copybrief magnum-fontconverter
- @subpage magnum-imageconverter --- @copybrief magnum-imageconverter - @subpage magnum-imageconverter --- @copybrief magnum-imageconverter
The following graphical apps are available:
- @subpage magnum-ui-gallery @m_class{m-label m-default m-flat} **live web demo** --- @copybrief magnum-ui-gallery
*/ */
} }

12
src/Magnum/Audio/al-info.cpp

@ -36,6 +36,18 @@ namespace Magnum {
@m_div{m-button m-primary} <a href="http://magnum.graphics/showcase/magnum-al-info/">@m_div{m-big}Live web version @m_enddiv @m_div{m-small} uses WebAssembly & WebAudio @m_enddiv </a> @m_enddiv @m_div{m-button m-primary} <a href="http://magnum.graphics/showcase/magnum-al-info/">@m_div{m-big}Live web version @m_enddiv @m_div{m-small} uses WebAssembly & WebAudio @m_enddiv </a> @m_enddiv
This utility depends on the [OpenAL](https://www.openal.org/) library. It is
built if both `WITH_AUDIO` and `WITH_AL_INFO` is enabled when building Magnum.
To use this utility with CMake, you need to request the `al-info` component of
the `Magnum` package and use the `Magnum::al-info` target for example in a
custom command:
@code{.cmake}
find_package(Magnum REQUIRED al-info)
add_custom_command(OUTPUT ... COMMAND Magnum::al-info ...)
@endcode
@section magnum-al-info-usage Usage @section magnum-al-info-usage Usage
@code{.sh} @code{.sh}

11
src/Magnum/Platform/gl-info.cpp

@ -87,6 +87,17 @@ namespace Magnum {
@m_div{m-button m-primary} <a href="http://magnum.graphics/showcase/magnum-info/">@m_div{m-big}Live web version @m_enddiv @m_div{m-small} uses WebAssembly & WebGL @m_enddiv </a> @m_enddiv @m_div{m-button m-primary} <a href="http://magnum.graphics/showcase/magnum-info/">@m_div{m-big}Live web version @m_enddiv @m_div{m-small} uses WebAssembly & WebGL @m_enddiv </a> @m_enddiv
This utility is built if both `WITH_GL` and `WITH_GL_INFO` is enabled when
building Magnum. To use this utility with CMake, you need to request the
`gl-info` component of the `Magnum` package and use the `Magnum::gl-info`
target for example in a custom command:
@code{.cmake}
find_package(Magnum REQUIRED gl-info)
add_custom_command(OUTPUT ... COMMAND Magnum::gl-info ...)
@endcode
@section magnum-gl-info-usage Usage @section magnum-gl-info-usage Usage
@code{.sh} @code{.sh}

11
src/Magnum/Text/fontconverter.cpp

@ -62,6 +62,17 @@ namespace Magnum {
@m_footernavigation @m_footernavigation
This utility is built if both `WITH_TEXT` and `WITH_FONTCONVERTER` is enabled
when building Magnum. To use this utility with CMake, you need to request the
`fontconverter` component of the `Magnum` package and use the
`Magnum::fontconverter` target for example in a custom command:
@code{.cmake}
find_package(Magnum REQUIRED fontconverter)
add_custom_command(OUTPUT ... COMMAND Magnum::fontconverter ...)
@endcode
@section magnum-fontconverter-usage Usage @section magnum-fontconverter-usage Usage
@code{.sh} @code{.sh}

12
src/Magnum/TextureTools/distancefieldconverter.cpp

@ -67,6 +67,18 @@ namespace Magnum {
@m_footernavigation @m_footernavigation
This utility is built if both `WITH_TEXTURETOOLS` and
`WITH_DISTANCEFIELDCONVERTER` is enabled when building Magnum. To use this
utility with CMake, you need to request the `distancefieldconverter` component
of the `Magnum` package and use the `Magnum::distancefieldconverter` target for
example in a custom command:
@code{.cmake}
find_package(Magnum REQUIRED distancefieldconverter)
add_custom_command(OUTPUT ... COMMAND Magnum::distancefieldconverter ...)
@endcode
@section magnum-distancefieldconverter-usage Usage @section magnum-distancefieldconverter-usage Usage
@code{.sh} @code{.sh}

11
src/Magnum/Trade/imageconverter.cpp

@ -39,6 +39,17 @@ namespace Magnum {
@m_footernavigation @m_footernavigation
This utility is built if both `WITH_TRADE` and `WITH_IMAGECONVERTER` is enabled
when building Magnum. To use this utility with CMake, you need to request the
`imageconverter` component of the `Magnum` package and use the
`Magnum::imageconverter` target for example in a custom command:
@code{.cmake}
find_package(Magnum REQUIRED imageconverter)
add_custom_command(OUTPUT ... COMMAND Magnum::imageconverter ...)
@endcode
@section magnum-imageconverter-usage Usage @section magnum-imageconverter-usage Usage
@code{.sh} @code{.sh}

Loading…
Cancel
Save