From c231b8c84cd908f880925c5208ff0d43c9a192d2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Mon, 31 Dec 2018 20:46:44 +0100 Subject: [PATCH] Doc++ --- doc/building.dox | 2 +- doc/changelog-old.dox | 2 +- doc/changelog.dox | 3 ++- doc/platforms-android.dox | 1 + src/Magnum/Animation/Animation.h | 2 ++ src/Magnum/Audio/Source.h | 2 +- src/Magnum/Shapes/AxisAlignedBox.h | 2 +- 7 files changed, 9 insertions(+), 5 deletions(-) diff --git a/doc/building.dox b/doc/building.dox index a46ea12f6..a7611dd05 100644 --- a/doc/building.dox +++ b/doc/building.dox @@ -325,7 +325,7 @@ want to set `CMAKE_INSTALL_RPATH` to `lib/` subdir of given prefix (e.g. @subsection building-windows Building on Windows On Windows you can use either MSVC or the MinGW-w64 compiler. It's then up to -you whether you will use QtCreator, Visual Studio or anoother IDE or do the +you whether you will use QtCreator, Visual Studio or another IDE or do the build from a command line. Note that for most convenient usage it's best use some dedicated directory (e.g. `C:/Sys`) for installing dependencies instead of putting each dependency to its own directory in `C:/Program Files` or diff --git a/doc/changelog-old.dox b/doc/changelog-old.dox index 92b523e18..0ebfbf195 100644 --- a/doc/changelog-old.dox +++ b/doc/changelog-old.dox @@ -421,7 +421,7 @@ for a high-level overview. @cpp ImageFormat @ce/@cpp ImageType @ce enums, use `Magnum/ColorFormat.h` header and @cpp ColorFormat @ce/@cpp ColorType @ce enums instead - Removed deprecated @cpp Matrix2 @ce and @cpp Matrix2d @ce typedefs, use - :ref:`Matrix2x2` and :ref:`Matrix2x2d` instead + @ref Matrix2x2 and @ref Matrix2x2d instead - Removed deprecated `Magnum/Swizzle.h` header and @cpp Magnum::swizzle() @ce function, use @ref Magnum/Math/Swizzle.h and @ref Math::swizzle() instead diff --git a/doc/changelog.dox b/doc/changelog.dox index 8b2758020..889b7ce99 100644 --- a/doc/changelog.dox +++ b/doc/changelog.dox @@ -127,7 +127,8 @@ See also: - Experimental support for creating Android APKs directly using CMake without Gradle involved. See @ref platforms-android-apps for more information. See - also [mosra/toolchains#5](https://github.com/mosra/toolchains/pull/5). + also [mosra/toolchains#5](https://github.com/mosra/toolchains/pull/5) and + [mosra/toolchains#6](https://github.com/mosra/toolchains/pull/6). - Initial scaffolding for [Hunter](https://hunter.sh) package support (see [mosra/magnum#298](https://github.com/mosra/magnum/pull/298)) - The `Magnum::AndroidApplication` target was missing a few dependency diff --git a/doc/platforms-android.dox b/doc/platforms-android.dox index 718c1d928..e67e9b5fb 100644 --- a/doc/platforms-android.dox +++ b/doc/platforms-android.dox @@ -30,6 +30,7 @@ namespace Magnum { @tableofcontents @m_footernavigation +@m_keywords{android_create_apk()} @todoc code coverage @todoc static plugins diff --git a/src/Magnum/Animation/Animation.h b/src/Magnum/Animation/Animation.h index eee5cdf6b..b90f16676 100644 --- a/src/Magnum/Animation/Animation.h +++ b/src/Magnum/Animation/Animation.h @@ -33,6 +33,7 @@ namespace Magnum { namespace Animation { +#ifndef DOXYGEN_GENERATING_OUTPUT namespace Implementation { template struct ResultTraits; template struct TypeTraits; @@ -48,6 +49,7 @@ template class Player; template> class Track; template class TrackViewStorage; template> class TrackView; +#endif }} diff --git a/src/Magnum/Audio/Source.h b/src/Magnum/Audio/Source.h index 72c0328f7..624fb3057 100644 --- a/src/Magnum/Audio/Source.h +++ b/src/Magnum/Audio/Source.h @@ -418,7 +418,7 @@ class MAGNUM_AUDIO_EXPORT Source { * Has effect only if the source is directional. Default is * @cpp 360.0_degf @ce. * @see @ref setInnerConeAngle(), @ref setDirection(), - * @ref setOuterConeGain() @fn_al_keyword{Sourcef} with + * @ref setOuterConeGain(), @fn_al_keyword{Sourcef} with * @def_al{CONE_OUTER_ANGLE} */ Source& setOuterConeAngle(Deg angle) { diff --git a/src/Magnum/Shapes/AxisAlignedBox.h b/src/Magnum/Shapes/AxisAlignedBox.h index 7b479a9c2..aab040ecd 100644 --- a/src/Magnum/Shapes/AxisAlignedBox.h +++ b/src/Magnum/Shapes/AxisAlignedBox.h @@ -26,7 +26,7 @@ */ /** @file -@brief Class @ref Magnum::Shapes::AxisAlignedBox, typedef @ref Magnum::Shapes::AxisAlignedBox2D, @ref Magnum::Shapes.:AxisAlignedBox3D +@brief Class @ref Magnum::Shapes::AxisAlignedBox, typedef @ref Magnum::Shapes::AxisAlignedBox2D, @ref Magnum::Shapes::AxisAlignedBox3D @deprecated The @ref Magnum::Shapes library is a failed design experiment and is scheduled for removal in a future release. Related geometry algorithms