diff --git a/src/Magnum/Audio/magnum-al-info.cpp b/src/Magnum/Audio/magnum-al-info.cpp index 273bab6a7..258859a3d 100644 --- a/src/Magnum/Audio/magnum-al-info.cpp +++ b/src/Magnum/Audio/magnum-al-info.cpp @@ -33,19 +33,25 @@ namespace Magnum { /** @page magnum-al-info Magnum OpenAL Info @brief Displays information about Magnum OpenAL capabilities +@m_footernavigation + @section magnum-al-info-usage Usage - magnum-al-info [-h|--help] [-s|--short] [--extension-strings] +@code{.shell-session} +magnum-al-info [-h|--help] [-s|--short] [--extension-strings] +@endcode Arguments: -- `-h`,` --help` -- display this help message and exit -- `-s`, `--short` -- display just essential info and exit -- `--extension-strings` -- list all extension strings provided by the driver + +- `-h`,` --help` --- display this help message and exit +- `-s`, `--short` --- display just essential info and exit +- `--extension-strings` --- list all extension strings provided by the driver (implies `--short`) @section magnum-al-info-example Example output -``` +@code{.shell-session} + +---------------------------------------------------------+ | Information about Magnum engine and OpenAL capabilities | +---------------------------------------------------------+ @@ -64,8 +70,8 @@ Vendor extension support: ALC_ENUMERATION_EXT SUPPORTED ALC_SOFTX_HRTF - ALC_SOFT_HRTF SUPPORTED - -``` + ... +@endcode */ diff --git a/src/Magnum/Platform/magnum-info.cpp b/src/Magnum/Platform/magnum-info.cpp index ea9b493b9..69702f87d 100644 --- a/src/Magnum/Platform/magnum-info.cpp +++ b/src/Magnum/Platform/magnum-info.cpp @@ -83,20 +83,27 @@ namespace Magnum { /** @page magnum-info Magnum Info @brief Displays information about Magnum engine and OpenGL capabilities +@m_footernavigation + @section magnum-info-usage Usage - magnum-info [--magnum-...] [-h|--help] [-s|--short] [--all-extensions] [--limits] +@code{.shell-session} +magnum-info [--magnum-...] [-h|--help] [-s|--short] [--all-extensions] + [--limits] +@endcode Arguments: -- `-h`, `--help` -- display this help message and exit -- `-s`, `--short` -- display just essential info and exit -- `--all-extensions` -- display extensions also for fully supported versions -- `--limits` -- display also limits and implementation-defined values -- `--magnum-...` -- engine-specific options (see @ref Context for details) + +- `-h`, `--help` --- display this help message and exit +- `-s`, `--short` --- display just essential info and exit +- `--all-extensions` --- display extensions also for fully supported versions +- `--limits` --- display also limits and implementation-defined values +- `--magnum-...` --- engine-specific options (see @ref Context for details) @section magnum-info-example Example output -``` +@code{.shell-session} + +---------------------------------------------------------+ | Information about Magnum engine and OpenGL capabilities | +---------------------------------------------------------+ @@ -131,7 +138,7 @@ Vendor extension support: GL_ARB_robustness - GL_ARB_robustness_isolation - ... -``` +@endcode */ diff --git a/src/Magnum/Text/fontconverter.cpp b/src/Magnum/Text/fontconverter.cpp index 7c3e8a5f5..9be4435a0 100644 --- a/src/Magnum/Text/fontconverter.cpp +++ b/src/Magnum/Text/fontconverter.cpp @@ -62,27 +62,34 @@ namespace Magnum { @page magnum-fontconverter Font conversion utility @brief Converts font to raster one of given atlas size +@m_footernavigation + @section magnum-fontconverter-usage Usage - magnum-fontconverter [--magnum-...] [-h|--help] --font FONT --converter CONVERTER [--plugin-dir DIR] [--characters CHARACTERS] [--font-size N] [--atlas-size "X Y"] [--output-size "X Y"] [--radius N] [--] input output +@code{.shell-session} +magnum-fontconverter [--magnum-...] [-h|--help] --font FONT + --converter CONVERTER [--plugin-dir DIR] [--characters CHARACTERS] + [--font-size N] [--atlas-size "X Y"] [--output-size "X Y"] [--radius N] + [--] input output +@endcode Arguments: -- `input` -- input font -- `output` -- output filename prefix -- `-h`, `--help` -- display help message and exit -- `--font FONT` -- font plugin -- `--converter CONVERTER` -- font converter plugin -- `--plugin-dir DIR` -- base plugin dir (defaults to plugin directory in +- `input` --- input font +- `output` --- output filename prefix +- `-h`, `--help` --- display help message and exit +- `--font FONT` --- font plugin +- `--converter CONVERTER` --- font converter plugin +- `--plugin-dir DIR` --- base plugin dir (defaults to plugin directory in Magnum install location) -- `--characters CHARACTERS` -- characters to include in the output (default: +- `--characters CHARACTERS` --- characters to include in the output (default: `abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789?!:;,. `) -- `--font-size N` -- input font size (default: `128`) -- `--atlas-size "X Y"` -- glyph atlas size (default: `"2048 2048"`) -- `--output-size "X Y"` -- output atlas size. If set to zero size, distance +- `--font-size N` --- input font size (default: `128`) +- `--atlas-size "X Y"` --- glyph atlas size (default: `"2048 2048"`) +- `--output-size "X Y"` --- output atlas size. If set to zero size, distance field computation will not be used. (default: `"256 256"`) -- `--radius N` -- distance field computation radius (default: `24`) -- `--magnum-...` -- engine-specific options (see @ref Context for details) +- `--radius N` --- distance field computation radius (default: `24`) +- `--magnum-...` --- engine-specific options (see @ref Context for details) The resulting font files can be then used as specified in the documentation of `converter` plugin. @@ -93,11 +100,14 @@ Making raster font from TTF file with default set of characters using @ref Text::FreeTypeFont "FreeTypeFont" font plugin and @ref Text::MagnumFontConverter "MagnumFontConverter" converter plugin: - magnum-fontconverter --font FreeTypeFont --converter MagnumFontConverter DejaVuSans.ttf myfont +@code{.shell-session} +magnum-fontconverter --font FreeTypeFont --converter MagnumFontConverter DejaVuSans.ttf myfont +@endcode -According to `MagnumFontConverter` plugin documentation, this will generate -files `myfont.conf` and `myfont.tga` in current directory. You can then load -and use them with the @ref Text::MagnumFont "MagnumFont" plugin. +According to @ref Text::MagnumFontConverter "MagnumFontConverter" plugin +documentation, this will generate files `myfont.conf` and `myfont.tga` in +current directory. You can then load and use them via the +@ref Text::MagnumFont "MagnumFont" plugin. */ namespace Text { diff --git a/src/Magnum/TextureTools/distancefieldconverter.cpp b/src/Magnum/TextureTools/distancefieldconverter.cpp index 2bee43654..1ec85b507 100644 --- a/src/Magnum/TextureTools/distancefieldconverter.cpp +++ b/src/Magnum/TextureTools/distancefieldconverter.cpp @@ -67,22 +67,30 @@ namespace Magnum { /** @page magnum-distancefieldconverter Distance Field conversion utility @brief Converts red channel of an image to distance field representation +@m_footernavigation + @section magnum-distancefieldconverter-usage Usage - magnum-distancefieldconverter [--magnum-...] [-h|--help] [--importer IMPORTER] [--converter CONVERTER] [--plugin-dir DIR] --output-size "X Y" --radius N [--] input output +@code{.shell-session} +magnum-distancefieldconverter [--magnum-...] [-h|--help] [--importer IMPORTER] + [--converter CONVERTER] [--plugin-dir DIR] --output-size "X Y" --radius N + [--] input output +@endcode Arguments: -- `input` -- input image -- `output` -- output image -- `-h`, `--help` -- display help message and exit -- `--importer IMPORTER` -- image importer plugin (default: @ref Trade::AnyImageImporter "AnyImageImporter") -- `--converter CONVERTER` -- image converter plugin (default: @ref Trade::AnyImageConverter "AnyImageConverter") -- `--plugin-dir DIR` -- base plugin dir (defaults to plugin directory in +- `input` --- input image +- `output` --- output image +- `-h`, `--help` --- display help message and exit +- `--importer IMPORTER` --- image importer plugin (default: + @ref Trade::AnyImageImporter "AnyImageImporter") +- `--converter CONVERTER` --- image converter plugin (default: + @ref Trade::AnyImageConverter "AnyImageConverter") +- `--plugin-dir DIR` --- base plugin dir (defaults to plugin directory in Magnum install location) -- `--output-size "X Y"` -- size of output image -- `--radius N` -- distance field computation radius -- `--magnum-...` -- engine-specific options (see @ref Context for details) +- `--output-size "X Y"` --- size of output image +- `--radius N` --- distance field computation radius +- `--magnum-...` --- engine-specific options (see @ref Context for details) Images with @ref PixelFormat::Red, @ref PixelFormat::RGB or @ref PixelFormat::RGBA are accepted on input. @@ -93,7 +101,9 @@ the algorithm and parameters. @section magnum-distancefield-example Example usage - magnum-distancefieldconverter --output-size "256 256" --radius 24 logo-src.png logo.png +@code{.shell-session} +magnum-distancefieldconverter --output-size "256 256" --radius 24 logo-src.png logo.png +@endcode This will open monochrome `logo-src.png` image using any plugin that can open PNG files and converts it to 256x256 distance field `logo.png` using any plugin diff --git a/src/Magnum/Trade/imageconverter.cpp b/src/Magnum/Trade/imageconverter.cpp index 6e73a28f2..6ba95ec54 100644 --- a/src/Magnum/Trade/imageconverter.cpp +++ b/src/Magnum/Trade/imageconverter.cpp @@ -36,31 +36,37 @@ namespace Magnum { -/** -@page magnum-imageconverter Image conversion utility +/** @page magnum-imageconverter Image conversion utility @brief Converts images of different formats +@m_footernavigation + @section magnum-imageconverter-usage Usage - magnum-imageconverter [-h|--help] [--importer IMPORTER] [--converter CONVERTER] [--plugin-dir DIR] [--] input output +@code{.shell-session} +magnum-imageconverter [-h|--help] [--importer IMPORTER] [--converter CONVERTER] + [--plugin-dir DIR] [--] input output +@endcode Arguments: -- `input` -- input image -- `output` -- output image -- `-h`, `--help` -- display this help message and exit -- `--importer IMPORTER` -- image importer plugin (default: +- `input` --- input image +- `output` --- output image +- `-h`, `--help` --- display this help message and exit +- `--importer IMPORTER` --- image importer plugin (default: @ref Trade::AnyImageImporter "AnyImageImporter") -- `--converter CONVERTER` -- image converter plugin (default: +- `--converter CONVERTER` --- image converter plugin (default: @ref Trade::AnyImageConverter "AnyImageConverter") -- `--plugin-dir DIR` -- base plugin dir (defaults to plugin directory in +- `--plugin-dir DIR` --- base plugin dir (defaults to plugin directory in Magnum install location) @section magnum-imageconverter-example Example usage Converting a JPEG file to a PNG: - magnum-imageconverter image.jpg image.png +@code{.shell-session} +magnum-imageconverter image.jpg image.png +@endcode */