From 799d9b80dbce03d1defd664f6414ac7598e145cb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Thu, 6 Sep 2018 21:37:31 +0200 Subject: [PATCH] Doc++ --- doc/transformations.dox | 2 +- src/Magnum/Audio/al-info.cpp | 1 + src/Magnum/Platform/gl-info.cpp | 1 + src/Magnum/Shaders/Phong.h | 8 ++++---- src/Magnum/Text/fontconverter.cpp | 1 + src/Magnum/TextureTools/distancefieldconverter.cpp | 1 + src/Magnum/Trade/imageconverter.cpp | 1 + 7 files changed, 10 insertions(+), 5 deletions(-) diff --git a/doc/transformations.dox b/doc/transformations.dox index a29b258f2..47edb3d12 100644 --- a/doc/transformations.dox +++ b/doc/transformations.dox @@ -29,7 +29,7 @@ namespace Magnum { @tableofcontents @m_footernavigation -@m_keyword{Transformations} +@m_keywords{Transformations} Transformations are essential operations involved in scene management --- object relations, hierarchies, animations etc. They extend basic vectors and matrices diff --git a/src/Magnum/Audio/al-info.cpp b/src/Magnum/Audio/al-info.cpp index d9d7da534..20dc24aa6 100644 --- a/src/Magnum/Audio/al-info.cpp +++ b/src/Magnum/Audio/al-info.cpp @@ -33,6 +33,7 @@ namespace Magnum { @brief Displays information about Magnum OpenAL capabilities @m_footernavigation +@m_keywords{magnum-al-info al-info} @m_div{m-button m-primary} @m_div{m-big}Live web version @m_enddiv @m_div{m-small} uses WebAssembly & WebAudio @m_enddiv @m_enddiv diff --git a/src/Magnum/Platform/gl-info.cpp b/src/Magnum/Platform/gl-info.cpp index e141f3930..ebb925b01 100644 --- a/src/Magnum/Platform/gl-info.cpp +++ b/src/Magnum/Platform/gl-info.cpp @@ -84,6 +84,7 @@ namespace Magnum { @brief Displays information about Magnum engine OpenGL capabilities @m_footernavigation +@m_keywords{magnum-gl-info gl-info} @m_div{m-button m-primary} @m_div{m-big}Live web version @m_enddiv @m_div{m-small} uses WebAssembly & WebGL @m_enddiv @m_enddiv diff --git a/src/Magnum/Shaders/Phong.h b/src/Magnum/Shaders/Phong.h index 421b960f8..7204e145c 100644 --- a/src/Magnum/Shaders/Phong.h +++ b/src/Magnum/Shaders/Phong.h @@ -88,10 +88,10 @@ platforms. With proper depth sorting and blending you'll usually get much better performance and output quality. For general alpha-masked drawing you need to provide ambient texture with alpha -channel and set alpha channel of diffuse/specular color to `0.0f` so only -ambient alpha will be taken into account. If you have diffuse texture combined -with the alpha mask, you can use that texture for both ambient and diffuse -part and then separate the alpha like this: +channel and set alpha channel of diffuse/specular color to @cpp 0.0f @ce so +only ambient alpha will be taken into account. If you have diffuse texture +combined with the alpha mask, you can use that texture for both ambient and +diffuse part and then separate the alpha like this: @snippet MagnumShaders.cpp Phong-usage-alpha diff --git a/src/Magnum/Text/fontconverter.cpp b/src/Magnum/Text/fontconverter.cpp index 0445620d5..d130da88c 100644 --- a/src/Magnum/Text/fontconverter.cpp +++ b/src/Magnum/Text/fontconverter.cpp @@ -61,6 +61,7 @@ namespace Magnum { @brief Converts font to raster one of given atlas size @m_footernavigation +@m_keywords{magnum-fontconverter fontconverter} 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 diff --git a/src/Magnum/TextureTools/distancefieldconverter.cpp b/src/Magnum/TextureTools/distancefieldconverter.cpp index aeeb03b29..29c8a1a20 100644 --- a/src/Magnum/TextureTools/distancefieldconverter.cpp +++ b/src/Magnum/TextureTools/distancefieldconverter.cpp @@ -66,6 +66,7 @@ namespace Magnum { @brief Converts red channel of an image to distance field representation @m_footernavigation +@m_keywords{magnum-distancefieldconverter distancefieldconverter} This utility is built if both `WITH_TEXTURETOOLS` and `WITH_DISTANCEFIELDCONVERTER` is enabled when building Magnum. To use this diff --git a/src/Magnum/Trade/imageconverter.cpp b/src/Magnum/Trade/imageconverter.cpp index 716703b9c..665b9c803 100644 --- a/src/Magnum/Trade/imageconverter.cpp +++ b/src/Magnum/Trade/imageconverter.cpp @@ -38,6 +38,7 @@ namespace Magnum { @brief Converts images of different formats @m_footernavigation +@m_keywords{magnum-imageconverter imageconverter} 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