From 616c4101cb3d4fef75f0a66e2c8b2d63fdaf935a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sun, 11 Nov 2012 01:43:41 +0100 Subject: [PATCH] Doc++ --- src/SceneGraph/AbstractGroupedFeature.h | 2 +- src/SceneGraph/AbstractObject.h | 6 +++--- src/SceneGraph/Camera.h | 3 ++- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/src/SceneGraph/AbstractGroupedFeature.h b/src/SceneGraph/AbstractGroupedFeature.h index a60ba6c55..3a5114dcd 100644 --- a/src/SceneGraph/AbstractGroupedFeature.h +++ b/src/SceneGraph/AbstractGroupedFeature.h @@ -33,7 +33,7 @@ template class FeatureGroup; Used together with FeatureGroup. -@section AbstractGroupedFeature-usage Usage +@section AbstractGroupedFeature-subclassing Subclassing Usage is via subclassing the feature using [CRTP](http://en.wikipedia.org/wiki/Curiously_recurring_template_pattern) and typedef'ing FeatureGroup to accept only given type, e.g.: diff --git a/src/SceneGraph/AbstractObject.h b/src/SceneGraph/AbstractObject.h index 286e56f2b..63d962981 100644 --- a/src/SceneGraph/AbstractObject.h +++ b/src/SceneGraph/AbstractObject.h @@ -33,9 +33,9 @@ template class AbstractFeature; /** @brief Base for objects -Provides minimal interface for features, not depending on object -transformation implementation. See Object or @ref scenegraph for more -information. +Provides minimal interface for features, not depending on object transformation +implementation. This class is not directly instantiatable, use Object subclass +instead. See also @ref scenegraph for more information. @see AbstractObject2D, AbstractObject3D */ diff --git a/src/SceneGraph/Camera.h b/src/SceneGraph/Camera.h index e9637fb70..96056e300 100644 --- a/src/SceneGraph/Camera.h +++ b/src/SceneGraph/Camera.h @@ -60,7 +60,8 @@ namespace Implementation { /** @brief Base for cameras -See Drawable documentation for more information. +See Drawable documentation for more information. This class is not directly +instantiatable, use Camera2D or Camera3D subclasses instead. @section AbstractCamera-explicit-specializations Explicit template specializations