From 6cc8362eeb7ff635bec7da4cdd92aa62cf6af653 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Tue, 2 Jan 2018 15:20:12 +0100 Subject: [PATCH] Doc++ --- doc/00-page-order.dox | 2 +- doc/features.dox | 5 ++++- doc/snippets/debugtools-compareimage.ansi | 4 +++- src/Magnum/SceneGraph/AbstractFeature.h | 7 ++++--- 4 files changed, 12 insertions(+), 6 deletions(-) diff --git a/doc/00-page-order.dox b/doc/00-page-order.dox index 6ab134e28..1b23a45ff 100644 --- a/doc/00-page-order.dox +++ b/doc/00-page-order.dox @@ -3,7 +3,7 @@ /** @page getting-started Getting started -@page features Feature overview +@page features Feature guide @page example-index Examples @page tips Tips and tricks @page utilities Utilities diff --git a/doc/features.dox b/doc/features.dox index 6c2d9e88c..e285f29e4 100644 --- a/doc/features.dox +++ b/doc/features.dox @@ -24,9 +24,12 @@ */ namespace Magnum { -/** @page features Feature overview +/** @page features Feature guide @brief Fundamental principles and design goals. +Overview and tutorials of high-level feature groups in Magnum. It's not +necessary to read through everything, pick only what you need. + - @subpage platform --- @copybrief platform - @subpage types --- @copybrief types - @subpage matrix-vector --- @copybrief matrix-vector diff --git a/doc/snippets/debugtools-compareimage.ansi b/doc/snippets/debugtools-compareimage.ansi index 6075f1c41..4fdb2e88f 100644 --- a/doc/snippets/debugtools-compareimage.ansi +++ b/doc/snippets/debugtools-compareimage.ansi @@ -1,6 +1,8 @@ Starting ProcessingTest with 1 test cases...  FAIL [1] process() at …/debugtools-compareimage.cpp on line 77 - Images actual and expected have max delta above threshold, actual 189 but at most 170 expected. Mean delta 13.5776 is below threshold 96. Delta image: + Images actual and expected have max delta above threshold, actual 189 + but at most 170 expected. Mean delta 13.5776 is below threshold 96. + Delta image: | | | | | ~8070DNMN8$ZD7 | diff --git a/src/Magnum/SceneGraph/AbstractFeature.h b/src/Magnum/SceneGraph/AbstractFeature.h index d96d543b5..919b527da 100644 --- a/src/Magnum/SceneGraph/AbstractFeature.h +++ b/src/Magnum/SceneGraph/AbstractFeature.h @@ -252,9 +252,10 @@ template class AbstractFeature /** * @brief Clean data based on absolute transformation * - * When object is cleaned and @ref CachedTransformation::Absolute is - * enabled in @ref setCachedTransformations(), this function is called - * to recalculate data based on absolute object transformation. + * When object is cleaned and + * @ref SceneGraph::CachedTransformation::Absolute "CachedTransformation::Absolute" + * is enabled in @ref setCachedTransformations(), this function is + * called to recalculate data based on absolute object transformation. * * Default implementation does nothing. * @see @ref scenegraph-features-caching, @ref cleanInverted()