From 7ec6c3b477a5288d2d075b6c855a1f6d084a3e76 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Fri, 13 Jan 2017 17:09:37 +0100 Subject: [PATCH] doc: reordered sections of building docs for consistency with cmake docs. --- doc/building.dox | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/doc/building.dox b/doc/building.dox index 49b4a67fe..540365d3c 100644 --- a/doc/building.dox +++ b/doc/building.dox @@ -228,6 +228,24 @@ information): - `WITH_GLXCONTEXT` -- GLX context - `WITH_WGLCONTEXT` -- WGL context +Magnum also contains a set of dependency-less plugins for importing essential +file formats. Additional plugins are provided in separate plugin repository, +see @ref building-plugins for more information. None of the plugins is built by +default. + +- `WITH_MAGNUMFONT` -- @ref Text::MagnumFont "MagnumFont" plugin. Available + only if `WITH_TEXT` is enabled. Enables also building of + @ref Trade::TgaImporter "TgaImporter" plugin. +- `WITH_MAGNUMFONTCONVERTER` -- @ref Text::MagnumFontConverter "MagnumFontConverter" + plugin. Available only if `WITH_TEXT` is enabled. Enables also building of + @ref Trade::TgaImageConverter "TgaImageConverter" plugin. +- `WITH_OBJIMPORTER` -- @ref Trade::ObjImporter "ObjImporter" plugin. +- `WITH_TGAIMPORTER` -- @ref Trade::TgaImporter "TgaImporter" plugin. +- `WITH_TGAIMAGECONVERTER` -- @ref Trade::TgaImageConverter "TgaImageConverter" + plugin. +- `WITH_WAVAUDIOIMPORTER` -- @ref Audio::WavImporter "WavAudioImporter" + plugin. Available only if `WITH_AUDIO` is enabled. + There are also a few command-line utilities, also disabled by default: - `WITH_MAGNUMINFO` - @ref magnum-info "magnum-info" executable, provides @@ -254,24 +272,6 @@ information. In particular, if you specify them as relative paths, the path will be taken relative to executable location, which is useful for making relocatable installations. -Magnum also contains a set of dependency-less plugins for importing essential -file formats. Additional plugins are provided in separate plugin repository, -see @ref building-plugins for more information. None of the plugins is built by -default. - -- `WITH_MAGNUMFONT` -- @ref Text::MagnumFont "MagnumFont" plugin. Available - only if `WITH_TEXT` is enabled. Enables also building of - @ref Trade::TgaImporter "TgaImporter" plugin. -- `WITH_MAGNUMFONTCONVERTER` -- @ref Text::MagnumFontConverter "MagnumFontConverter" - plugin. Available only if `WITH_TEXT` is enabled. Enables also building of - @ref Trade::TgaImageConverter "TgaImageConverter" plugin. -- `WITH_OBJIMPORTER` -- @ref Trade::ObjImporter "ObjImporter" plugin. -- `WITH_TGAIMPORTER` -- @ref Trade::TgaImporter "TgaImporter" plugin. -- `WITH_TGAIMAGECONVERTER` -- @ref Trade::TgaImageConverter "TgaImageConverter" - plugin. -- `WITH_WAVAUDIOIMPORTER` -- @ref Audio::WavImporter "WavAudioImporter" - plugin. Available only if `WITH_AUDIO` is enabled. - Note that [each namespace](namespaces.html) and all @ref Platform libraries contain more detailed information about dependencies, availability on particular platform and also guide how to enable given library in build and use