Browse Source

doc: reordered sections of building docs for consistency with cmake docs.

pull/190/head
Vladimír Vondruš 9 years ago
parent
commit
7ec6c3b477
  1. 36
      doc/building.dox

36
doc/building.dox

@ -228,6 +228,24 @@ information):
- `WITH_GLXCONTEXT` -- GLX context - `WITH_GLXCONTEXT` -- GLX context
- `WITH_WGLCONTEXT` -- WGL 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: There are also a few command-line utilities, also disabled by default:
- `WITH_MAGNUMINFO` - @ref magnum-info "magnum-info" executable, provides - `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 will be taken relative to executable location, which is useful for making
relocatable installations. 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 Note that [each namespace](namespaces.html) and all @ref Platform libraries
contain more detailed information about dependencies, availability on contain more detailed information about dependencies, availability on
particular platform and also guide how to enable given library in build and use particular platform and also guide how to enable given library in build and use

Loading…
Cancel
Save