Browse Source

Doc++

pull/225/head
Vladimír Vondruš 8 years ago
parent
commit
6cc8362eeb
  1. 2
      doc/00-page-order.dox
  2. 5
      doc/features.dox
  3. 4
      doc/snippets/debugtools-compareimage.ansi
  4. 7
      src/Magnum/SceneGraph/AbstractFeature.h

2
doc/00-page-order.dox

@ -3,7 +3,7 @@
/** /**
@page getting-started Getting started @page getting-started Getting started
@page features Feature overview @page features Feature guide
@page example-index Examples @page example-index Examples
@page tips Tips and tricks @page tips Tips and tricks
@page utilities Utilities @page utilities Utilities

5
doc/features.dox

@ -24,9 +24,12 @@
*/ */
namespace Magnum { namespace Magnum {
/** @page features Feature overview /** @page features Feature guide
@brief Fundamental principles and design goals. @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 platform --- @copybrief platform
- @subpage types --- @copybrief types - @subpage types --- @copybrief types
- @subpage matrix-vector --- @copybrief matrix-vector - @subpage matrix-vector --- @copybrief matrix-vector

4
doc/snippets/debugtools-compareimage.ansi

@ -1,6 +1,8 @@
Starting ProcessingTest with 1 test cases... Starting ProcessingTest with 1 test cases...
 FAIL [1] process() at …/debugtools-compareimage.cpp on line 77  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 | | ~8070DNMN8$ZD7 |

7
src/Magnum/SceneGraph/AbstractFeature.h

@ -252,9 +252,10 @@ template<UnsignedInt dimensions, class T> class AbstractFeature
/** /**
* @brief Clean data based on absolute transformation * @brief Clean data based on absolute transformation
* *
* When object is cleaned and @ref CachedTransformation::Absolute is * When object is cleaned and
* enabled in @ref setCachedTransformations(), this function is called * @ref SceneGraph::CachedTransformation::Absolute "CachedTransformation::Absolute"
* to recalculate data based on absolute object transformation. * is enabled in @ref setCachedTransformations(), this function is
* called to recalculate data based on absolute object transformation.
* *
* Default implementation does nothing. * Default implementation does nothing.
* @see @ref scenegraph-features-caching, @ref cleanInverted() * @see @ref scenegraph-features-caching, @ref cleanInverted()

Loading…
Cancel
Save