From 222292239b631c7a2a356a008a3799378d9f5638 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sat, 11 Jan 2014 00:31:02 +0100 Subject: [PATCH] Making includes absolute, part 7: fix documentation. --- Doxyfile | 7 ++++--- doc/building.dox | 6 +++--- doc/getting-started.dox | 10 +++++----- doc/namespaces.dox | 37 +++++++++++++++++------------------- src/Magnum/Array.h | 2 +- src/Magnum/Buffer.h | 2 +- src/Magnum/Context.h | 2 +- src/Magnum/Renderer.h | 2 +- src/Magnum/Resource.h | 2 +- src/Magnum/ResourceManager.h | 2 +- src/Magnum/Swizzle.h | 2 +- 11 files changed, 36 insertions(+), 38 deletions(-) diff --git a/Doxyfile b/Doxyfile index 72837b78a..f6ba88232 100644 --- a/Doxyfile +++ b/Doxyfile @@ -689,11 +689,12 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = src/ \ +INPUT = src/Magnum \ + src/MagnumPlugins \ doc/ \ - ../magnum-plugins/src/ \ + ../magnum-plugins/src/MagnumPlugins \ ../magnum-plugins/doc/ \ - ../magnum-integration/src/ \ + ../magnum-integration/src/Magnum \ ../magnum-integration/doc/ \ ../magnum-examples/doc/ diff --git a/doc/building.dox b/doc/building.dox index 08d302075..31ce244a2 100644 --- a/doc/building.dox +++ b/doc/building.dox @@ -139,9 +139,9 @@ available for desktop OpenGL only, see @ref requires-gl. emulation in desktop OpenGL library. Might not be supported in all drivers. The features used can be conveniently detected in depending projects both in -CMake and C++ sources, see @ref cmake and @ref src/Magnum.h for more -information. See also @ref corrade-cmake and @ref src/Corrade.h for additional -information. +CMake and C++ sources, see @ref cmake and @ref Magnum/Magnum.h for more +information. See also @ref corrade-cmake and @ref Corrade/Corrade.h for +additional information. By default the engine is built with nearly everything except Audio library, plugins and application libraries (see below). Using `WITH_*` CMake parameters diff --git a/doc/getting-started.dox b/doc/getting-started.dox index 297862778..0e9daef78 100644 --- a/doc/getting-started.dox +++ b/doc/getting-started.dox @@ -85,8 +85,8 @@ repository. Directory `src/` contains the actual project. To keep things simple, the project consists of just one source file with the most minimal code possible: @code -#include -#include +#include +#include using namespace Magnum; @@ -160,9 +160,9 @@ the concepts of graphics programming, we can change clear color to something else and also print basic information about the GPU the engine is running on. First include the needed headers: @code -#include -#include -#include +#include +#include +#include @endcode And in the constructor (which is currently empty) change the clear color and diff --git a/doc/namespaces.dox b/doc/namespaces.dox index 1bd43d68a..e1b4aa8b1 100644 --- a/doc/namespaces.dox +++ b/doc/namespaces.dox @@ -22,10 +22,7 @@ DEALINGS IN THE SOFTWARE. */ -/** @dir magnum - * @brief %Magnum library - */ -/** @dir magnum/src +/** @dir Magnum * @brief Namespace Magnum */ /** @namespace Magnum @@ -39,7 +36,7 @@ to `${MAGNUM_LIBRARIES}`. See @ref building and @ref cmake for more information. */ -/** @dir Platform +/** @dir Magnum/Platform * @brief Namespace Magnum::Platform */ /** @namespace Magnum::Platform @@ -57,7 +54,7 @@ documentation, @ref building, @ref cmake and @ref platform for more information. */ -/** @dir Math +/** @dir Magnum/Math * @brief Namespace Magnum::Math */ /** @namespace Magnum::Math @@ -71,7 +68,7 @@ to `${MAGNUM_LIBRARIES}`. See @ref building, @ref cmake, @ref matrix-vector and @ref transformations for more information. */ -/** @dir Math/Algorithms +/** @dir Magnum/Math/Algorithms * @brief Namespace Magnum::Math::Algorithms */ /** @namespace Magnum::Math::Algorithms @@ -85,7 +82,7 @@ to `${MAGNUM_LIBRARIES}`. See @ref building and @ref cmake for more information. */ -/** @dir Math/Geometry +/** @dir Magnum/Math/Geometry * @brief Namespace Magnum::Math::Geometry */ /** @namespace Magnum::Math::Geometry @@ -99,7 +96,7 @@ to `${MAGNUM_LIBRARIES}`. See @ref building and @ref cmake for more information. */ -/** @dir Audio +/** @dir Magnum/Audio * @brief Namespace Magnum::Audio */ /** @namespace Magnum::Audio @@ -116,7 +113,7 @@ particular `*Importer` class documentation, @ref building-plugins, @ref cmake-plugins and @ref plugins for more information. */ -/** @dir DebugTools +/** @dir Magnum/DebugTools * @brief Namespace Magnum::DebugTools */ /** @namespace Magnum::DebugTools @@ -130,7 +127,7 @@ package in CMake and link to `${MAGNUM_DEBUGTOOLS_LIBRARIES}`. See @ref building, @ref cmake and @ref debug-tools for more information. */ -/** @dir MeshTools +/** @dir Magnum/MeshTools * @brief Namespace Magnum::MeshTools */ /** @namespace Magnum::MeshTools @@ -144,11 +141,11 @@ package in CMake and link to `${MAGNUM_MESHTOOLS_LIBRARIES}`. See @ref building and @ref cmake for more information. */ -/** @dir Plugins - * @brief Basic plugins +/** @dir MagnumPlugins + * @brief Plugins for %Magnum library */ -/** @dir Primitives +/** @dir Magnum/Primitives * @brief Namespace Magnum::Primitives */ /** @namespace Magnum::Primitives @@ -162,7 +159,7 @@ package in CMake and link to `${MAGNUM_PRIMITIVES_LIBRARIES}`. See @ref building and @ref cmake for more information. */ -/** @dir SceneGraph +/** @dir Magnum/SceneGraph * @brief Namespace Magnum::SceneGraph */ /** @@ -177,7 +174,7 @@ package in CMake and link to `${MAGNUM_SCENEGRAPH_LIBRARIES}`. See @ref building, @ref cmake and @ref scenegraph for more information. */ -/** @dir Shaders +/** @dir Magnum/Shaders * @brief Namespace Magnum::Shaders */ /** @namespace Magnum::Shaders @@ -191,7 +188,7 @@ in CMake and link to `${MAGNUM_MESHTOOLS_SHADERS}`. See @ref building and @ref cmake for more information. */ -/** @dir Shapes +/** @dir Magnum/Shapes * @brief Namespace Magnum::Shapes */ /** @namespace Magnum::Shapes @@ -205,7 +202,7 @@ CMake and link to `${MAGNUM_SHAPES_LIBRARIES}`. See @ref building, @ref cmake and @ref shapes for more information. */ -/** @dir Text +/** @dir Magnum/Text * @brief Namespace Magnum::Text */ /** @namespace Magnum::Text @@ -221,7 +218,7 @@ for more information. Additional plugins are enabled separately, see particular @ref cmake-plugins and @ref plugins for more information. */ -/** @dir TextureTools +/** @dir Magnum/TextureTools * @brief Namespace Magnum::TextureTools */ /** @namespace Magnum::TextureTools @@ -235,7 +232,7 @@ package in CMake and link to `${MAGNUM_TEXTURETOOLS_LIBRARIES}`. See @ref building and @ref cmake for more information. */ -/** @dir Trade +/** @dir Magnum/Trade * @brief Namespace Magnum::Trade */ /** @namespace Magnum::Trade diff --git a/src/Magnum/Array.h b/src/Magnum/Array.h index 2e324e2c5..35586f899 100644 --- a/src/Magnum/Array.h +++ b/src/Magnum/Array.h @@ -24,7 +24,7 @@ DEALINGS IN THE SOFTWARE. */ -/** @file /Array.h +/** @file * @brief Class Magnum::Array, Magnum::Array1D, Magnum::Array2D, Magnum::Array3D */ diff --git a/src/Magnum/Buffer.h b/src/Magnum/Buffer.h index 0ecfa0632..e3e975ae7 100644 --- a/src/Magnum/Buffer.h +++ b/src/Magnum/Buffer.h @@ -24,7 +24,7 @@ DEALINGS IN THE SOFTWARE. */ -/** @file /Buffer.h +/** @file * @brief Class @ref Magnum::Buffer, enum @ref Magnum::BufferUsage */ diff --git a/src/Magnum/Context.h b/src/Magnum/Context.h index efe95f141..c0b4c6647 100644 --- a/src/Magnum/Context.h +++ b/src/Magnum/Context.h @@ -24,7 +24,7 @@ DEALINGS IN THE SOFTWARE. */ -/** @file /Context.h +/** @file * @brief Class @ref Magnum::Context, @ref Magnum::Extension, macro @ref MAGNUM_ASSERT_VERSION_SUPPORTED(), @ref MAGNUM_ASSERT_EXTENSION_SUPPORTED() */ diff --git a/src/Magnum/Renderer.h b/src/Magnum/Renderer.h index 5d5dc675d..af166007e 100644 --- a/src/Magnum/Renderer.h +++ b/src/Magnum/Renderer.h @@ -24,7 +24,7 @@ DEALINGS IN THE SOFTWARE. */ -/** @file /Renderer.h +/** @file * @brief Class Magnum::Renderer */ diff --git a/src/Magnum/Resource.h b/src/Magnum/Resource.h index 38fcfbd96..c82f22565 100644 --- a/src/Magnum/Resource.h +++ b/src/Magnum/Resource.h @@ -24,7 +24,7 @@ DEALINGS IN THE SOFTWARE. */ -/** @file /Resource.h +/** @file * @brief Class Magnum::ResourceKey, Magnum::Resource, enum Magnum::ResourceState */ diff --git a/src/Magnum/ResourceManager.h b/src/Magnum/ResourceManager.h index 247d3d0f3..3785ea303 100644 --- a/src/Magnum/ResourceManager.h +++ b/src/Magnum/ResourceManager.h @@ -24,7 +24,7 @@ DEALINGS IN THE SOFTWARE. */ -/** @file /ResourceManager.h +/** @file * @brief Class Magnum::ResourceManager, enum Magnum::ResourceDataState, Magnum::ResourcePolicy */ diff --git a/src/Magnum/Swizzle.h b/src/Magnum/Swizzle.h index 8ca272d33..01fa066a0 100644 --- a/src/Magnum/Swizzle.h +++ b/src/Magnum/Swizzle.h @@ -25,7 +25,7 @@ */ #ifdef MAGNUM_BUILD_DEPRECATED -/** @file /Swizzle.h +/** @file * @brief Function @ref Magnum::swizzle() * @deprecated Use @ref Math/Swizzle.h instead. */