Doxygen grouping 35/45135/5
authorYoonsang Lee <ysang114.lee@samsung.com>
Thu, 23 Jul 2015 05:38:18 +0000 (14:38 +0900)
committerYoonsang Lee <ysang114.lee@samsung.com>
Wed, 2 Sep 2015 02:10:41 +0000 (11:10 +0900)
- Grouping using @defgroup, @ingroup, @addtogroup
- Results are shown in the "Modules" tab of the generated doxygen html
- Grouping doxygen comments are in doc/xxx_doc.h
- Install doc/xxx_doc.h as well when conducting 'make install'

Change-Id: I46830ecf57a4ad842a6cd5cb63a98968f0a23dda

102 files changed:
build/tizen/dali-core/Makefile.am
dali/public-api/actors/actor-enumerations.h
dali/public-api/actors/actor.h
dali/public-api/actors/blending.h
dali/public-api/actors/camera-actor.h
dali/public-api/actors/custom-actor-impl.h
dali/public-api/actors/custom-actor.h
dali/public-api/actors/draw-mode.h
dali/public-api/actors/image-actor.h
dali/public-api/actors/layer.h
dali/public-api/actors/sampling.h
dali/public-api/animation/alpha-function.h
dali/public-api/animation/animation.h
dali/public-api/animation/constraint-source.h
dali/public-api/animation/constraint.h
dali/public-api/animation/constraints.h
dali/public-api/animation/key-frames.h
dali/public-api/animation/linear-constrainer.h
dali/public-api/animation/path.h
dali/public-api/animation/time-period.h
dali/public-api/common/compile-time-assert.h
dali/public-api/common/constants.h
dali/public-api/common/dali-common.h
dali/public-api/common/dali-vector.h
dali/public-api/common/intrusive-ptr.h
dali/public-api/common/loading-state.h
dali/public-api/common/stage.h
dali/public-api/common/type-traits.h
dali/public-api/common/view-mode.h
dali/public-api/events/gesture-detector.h
dali/public-api/events/gesture.h
dali/public-api/events/hover-event.h
dali/public-api/events/key-event.h
dali/public-api/events/long-press-gesture-detector.h
dali/public-api/events/long-press-gesture.h
dali/public-api/events/pan-gesture-detector.h
dali/public-api/events/pan-gesture.h
dali/public-api/events/pinch-gesture-detector.h
dali/public-api/events/pinch-gesture.h
dali/public-api/events/tap-gesture-detector.h
dali/public-api/events/tap-gesture.h
dali/public-api/events/touch-event.h
dali/public-api/events/touch-point.h
dali/public-api/events/wheel-event.h
dali/public-api/images/buffer-image.h
dali/public-api/images/encoded-buffer-image.h
dali/public-api/images/frame-buffer-image.h
dali/public-api/images/image-operations.h
dali/public-api/images/image.h
dali/public-api/images/native-image-interface.h
dali/public-api/images/native-image.h
dali/public-api/images/nine-patch-image.h
dali/public-api/images/pixel.h
dali/public-api/images/resource-image.h
dali/public-api/math/angle-axis.h
dali/public-api/math/compile-time-math.h
dali/public-api/math/degree.h
dali/public-api/math/math-utils.h
dali/public-api/math/matrix.h
dali/public-api/math/matrix3.h
dali/public-api/math/quaternion.h
dali/public-api/math/radian.h
dali/public-api/math/random.h
dali/public-api/math/rect.h
dali/public-api/math/uint-16-pair.h
dali/public-api/math/vector2.h
dali/public-api/math/vector3.h
dali/public-api/math/vector4.h
dali/public-api/math/viewport.h
dali/public-api/object/any.h
dali/public-api/object/base-handle.h
dali/public-api/object/base-object.h
dali/public-api/object/handle.h
dali/public-api/object/object-registry.h
dali/public-api/object/property-array.h
dali/public-api/object/property-conditions.h
dali/public-api/object/property-index-ranges.h
dali/public-api/object/property-input.h
dali/public-api/object/property-map.h
dali/public-api/object/property-notification-declarations.h
dali/public-api/object/property-notification.h
dali/public-api/object/property-types.h
dali/public-api/object/property-value.h
dali/public-api/object/property.h
dali/public-api/object/ref-object.h
dali/public-api/object/type-info.h
dali/public-api/object/type-registry.h
dali/public-api/render-tasks/render-task-list.h
dali/public-api/render-tasks/render-task.h
dali/public-api/shader-effects/shader-effect.h
dali/public-api/signals/base-signal.h
dali/public-api/signals/callback.h
dali/public-api/signals/connection-tracker-interface.h
dali/public-api/signals/connection-tracker.h
dali/public-api/signals/dali-signal.h
dali/public-api/signals/functor-delegate.h
dali/public-api/signals/signal-slot-connections.h
dali/public-api/signals/signal-slot-observers.h
dali/public-api/signals/slot-delegate.h
doc/dali-core-doc.h [new file with mode: 0644]
doc/file.list [new file with mode: 0644]
packaging/dali.spec

index 9db8a2a2d8cd502328ff79076e067e4cacc82e61..823fc934632c95b29ee3e0b068d0c3a03e571cfa 100644 (file)
@@ -31,6 +31,9 @@ include ../../../dali/devel-api/file.list
 platform_abstraction_src_dir = ../../../dali/integration-api
 include ../../../dali/integration-api/file.list
 
+package_doxy_dir = ../../../doc
+include ../../../doc/file.list
+
 # Build the Dali libtool library
 
 src_files = $(internal_src_files) \
@@ -136,6 +139,10 @@ publicapisignals_HEADERS = $(public_api_core_signals_header_files)
 CLEANFILES = dali-shaders.cpp \
              dali-shaders.h
 
+# package doxygen file (contains doxygen grouping information)
+packagedoxydir = $(devincludepath)/dali/doc
+packagedoxy_HEADERS = $(package_doxy_files)
+
 # linking test
 
 noinst_PROGRAMS = linker.test
index dc86d14872302b30d2f9a649505ff93a684a2a38..982055aa4c6f38434f7771aed01838ac549014e8 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-actors
+ * @{
+ */
 
 /**
  * @brief Actor color mode.
@@ -120,6 +124,9 @@ enum Type
 };
 }
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_ACTOR_ENUMERATIONS_H__
index 857395dea5d614c764734c32254d9dd74608e692..dac29bddd395cdb09868e029f86eaa15cdc50eba 100644 (file)
 #include <dali/public-api/signals/dali-signal.h>
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-actors
+ * @{
+ */
 
 namespace Internal DALI_INTERNAL
 {
@@ -233,6 +237,7 @@ typedef Rect<float> Padding;      ///< Padding definition
  * | show              | %SetVisible( true )          |
  * | hide              | %SetVisible( false )         |
  */
+
 class DALI_IMPORT_API Actor : public Handle
 {
 public:
@@ -1411,8 +1416,9 @@ inline void UnparentAndReset( Actor& actor )
   }
 }
 
-
-
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_ACTOR_H__
index f46d9f83de67bddf733df0f1e07b942b565eab2d..a6b88e6a6291819ad430ceba389ff6c591513573 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-actors
+ * @{
+ */
 
 namespace BlendingMode
 {
@@ -91,6 +95,9 @@ DALI_IMPORT_API extern const BlendingFactor::Type   DEFAULT_BLENDING_DEST_FACTOR
 DALI_IMPORT_API extern const BlendingEquation::Type DEFAULT_BLENDING_EQUATION_RGB;     ///< BlendingEquation::ADD
 DALI_IMPORT_API extern const BlendingEquation::Type DEFAULT_BLENDING_EQUATION_ALPHA;   ///< BlendingEquation::ADD
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_BLENDING_H__
index 618b0fcdf8f2ea2adb601a294b4478f5f9ae49aa..b7dd645f95fd20c993abc991c35913bd665971fe 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-actors
+ * @{
+ */
 
 namespace Internal DALI_INTERNAL
 {
 class CameraActor;
 }
 
-
 namespace Camera
 {
 /**
@@ -327,6 +330,9 @@ public: // Not intended for use by Application developers
   explicit DALI_INTERNAL CameraActor(Internal::CameraActor* actor);
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_CAMERA_ACTOR_H__
index d24637815f6bcbbf876223bbc308b93588b14520..c2f58709d8db2cb947e39d494e3c40a0043e45d1 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-actors
+ * @{
+ */
 
 namespace Internal DALI_INTERNAL
 {
@@ -44,7 +48,6 @@ struct WheelEvent;
 struct Vector2;
 struct Vector3;
 
-
 /**
  * @brief Pointer to Dali::CustomActorImpl object.
  */
@@ -398,6 +401,9 @@ private:
   ActorFlags mFlags :ACTOR_FLAG_COUNT;  ///< ActorFlags flags to determine behaviour
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_CUSTOM_ACTOR_IMPL_H__
index 441b05273723687ca04381f185ef2c603542df15..9657c090d2cddb3aa3e964abff612fddaf8cb10f 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-actors
+ * @{
+ */
 
 namespace Internal DALI_INTERNAL
 {
@@ -111,6 +115,9 @@ public: // Not intended for application developers
   CustomActor(Internal::CustomActor* actor);
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_CUSTOM_ACTOR_H__
index 25ac0a6b9e5c178091832aa28fc9c453bed9f258..86e9de859675bc055b432cefd4624fc614226ae8 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-actors
+ * @{
+ */
 
 namespace DrawMode
 {
@@ -40,6 +44,9 @@ enum Type
 
 } // namespace DrawMode
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_DRAW_MODE_H__
index 136cb8a8e7cd968a0bd294b0f225fd310c762276..65abd5160d459a53d776a7917a63e7e66c85b171 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-actors
+ * @{
+ */
 
 namespace Internal DALI_INTERNAL
 {
@@ -509,6 +513,9 @@ DALI_IMPORT_API void SetShaderEffectRecursively( Actor actor, ShaderEffect effec
  */
 DALI_IMPORT_API void RemoveShaderEffectRecursively( Actor actor );
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_IMAGE_ACTOR_H__
index 036c79c9d6f0d9d0232d59862a794280f65937f0..d2855266a26e55ece8788d143365db7343325665 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-actors
+ * @{
+ */
 
 namespace Internal DALI_INTERNAL
 {
@@ -391,6 +395,9 @@ public: // Not intended for application developers
   explicit DALI_INTERNAL Layer(Internal::Layer* Layer);
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif //__DALI_LAYER_H__
index c087342964f07cb642d2ec5451507c2e57d7f387..19f6128a696c037217623c5f1a82fdf440f417c0 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-actors
+ * @{
+ */
 
 namespace FilterMode
 {
@@ -40,6 +44,9 @@ enum Type
 
 } //namespace FilterMode
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_SAMPLING_H__
index 2e3bffa183ca6d802478ec017f7a29aacc9d3f44..eb6e06fdaa363b46ed687f6acc31c93b71384101 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-animation
+ * @{
+ */
 
 typedef float (*AlphaFunctionPrototype)(float progress); ///< Prototype of an alpha function
 
@@ -148,6 +152,9 @@ private:
   Mode                    mMode    : 2;                   //< Enum indicating the functioning mode of the AlphaFunction
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_ALPHA_FUNCTION_H__
index f376f82dba70739a2af6737da5765d91e34fa7b8..41c9879ffce3f631a6b875103f7b0c52dfdf8979 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-animation
+ * @{
+ */
 
 class Actor;
 struct Property;
@@ -583,6 +587,9 @@ public: // Not intended for use by Application developers
 
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_ANIMATION_H__
index 9d107e89814f911c8a4ab7653ffdad745af8a6ca..4c3bfe4931fa0659edd3ab6347535afdd52372b9 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-animation
+ * @{
+ */
 
 /**
  * @brief Constraint source types.
@@ -119,6 +123,9 @@ struct DALI_IMPORT_API ConstraintSource
   Handle object; ///< The target object; only valid if sourceType == OBJECT_PROPERTY
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_CONSTRAINT_SOURCE_H__
index 6f51a6850c20cbbea937282e19a406bfbc97cb99..536b367d56e847392c7db50aa243ae7347617dd1 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-animation
+ * @{
+ */
 
 class Handle;
 
@@ -497,6 +501,9 @@ private: // Not intended for use by Application developers
   static Constraint New( Handle handle, Property::Index targetIndex, Property::Type targetType, CallbackBase* function );
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_CONSTRAINT_H__
index 438bff60ace10fbdd068577eeff20aefdc8401c7..3d0cd4e06ddd7e4c490afc8d4f2126934ac0d2b4 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-animation
+ * @{
+ */
 
 /**
  * @brief EqualToConstraint
@@ -218,6 +222,9 @@ inline void LookAt( Quaternion& current, const PropertyInputContainer& inputs )
   current = Quaternion( vX, vY, vForward );
 }
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_CONSTRAINTS_H__
index 56a6679e217a7d1326dbbf556b4a277c74e969d1..05ecf9fa8993d5a31638c1f2722ffaae22613764 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-animation
+ * @{
+ */
 
 namespace Internal DALI_INTERNAL
 {
@@ -127,6 +131,9 @@ public: // Not intended for application developers
   explicit DALI_INTERNAL KeyFrames(Internal::KeyFrames* keyFrames);
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_KEY_FRAMES_H__
index 917a4eb90fdaf386bf9fedcf60d4952a19aca26f..c97a5742dca538bb92d4b3fe463a8b6a72050bc5 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-animation
+ * @{
+ */
 
 namespace Internal DALI_INTERNAL
 {
   class LinearConstrainer;
 }
+
 /**
  * @brief
  *
@@ -129,6 +134,9 @@ public: // Not intended for application developers
   explicit DALI_INTERNAL LinearConstrainer(Internal::LinearConstrainer* pathConstrainer);
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_LINEAR_CONSTRAINER_H__
index 2531d08e3d15befddcca6e2d395dc6374fa3e1dd..44a85fad6b917721dc4194ce82780d8763dc08d5 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-animation
+ * @{
+ */
 
 namespace Internal DALI_INTERNAL
 {
 class Path;
 }
+
 /**
  * @brief A 3D parametric curve
  *
@@ -172,6 +177,9 @@ public: // Not intended for application developers
   explicit DALI_INTERNAL Path(Internal::Path* path);
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_KEY_FRAMES_H__
index fe552ad8bcd9566a595cdb6763b3499c88ad7047..d48736c345f80428a2bb00b54405f9281b51e3ca 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-animation
+ * @{
+ */
 
 /**
  * @brief A value-type representing a period of time within an animation.
@@ -53,6 +57,9 @@ struct DALI_IMPORT_API TimePeriod
   float durationSeconds; ///< The duration of the time period in seconds
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_TIME_PERIOD_H__
index b400f48da05a740e07f52d70b9dc87d394146c56..1cf7bb5dc8a1f1e2a8bb30d723a07fb0d38ba006 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-common
+ * @{
+ */
 
 template <bool x> struct CompileTimeAssertBool;    ///< Bool Template to test condition
 template <> struct CompileTimeAssertBool<true> {}; ///< Specialize for true, but not for false
@@ -39,6 +43,9 @@ template<int x> struct CompileTimeAssertInt {};    ///< Template to wrap conditi
  */
 #define DALI_COMPILE_TIME_ASSERT( x ) typedef CompileTimeAssertInt< sizeof( CompileTimeAssertBool< ( x ) > ) > CompileTimeAssertType __attribute__((__unused__))
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_COMPILE_TIME_ASSERT_H__
index 7a14681d07087af7c5b9d690e008062dfbd898e4..91cf4fa334d8a8efc2024863bb356feb2b4120d4 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-common
+ * @{
+ */
 
 /**
  * @brief ParentOrigin constants
@@ -124,6 +128,9 @@ static const float ONE80_OVER_PI = 180.0f/Dali::Math::PI; ///< Constant used to
 
 } // namespace Math
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_CONSTANTS_H__
index 39558c0ecb58df12d4206f17ffeff2848f510df1..1b8881cfc72e6280984e854449af1e5fa3100dab 100644 (file)
@@ -23,6 +23,7 @@
 #ifdef EMSCRIPTEN
 #include <emscripten/emscripten.h>
 #endif
+
 /*
  * Definitions for shared library support
  *
  */
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-common
+ * @{
+ */
 
 /**
  * @brief Method to log assertion message in DALI_ASSERT_ALWAYS macro below.
@@ -108,6 +113,9 @@ public:
   const char* condition;
 };
 
+/**
+ * @}
+ */
 }// Dali
 
 /**
index 359e6dc90f50c1aba3e360e2ce6f7da287cc11d6..9e5a63922bf4eab31502df5312c90b0014c913e0 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-common
+ * @{
+ */
 
 /**
  * @brief Base class to handle the memory of simple vector.
@@ -693,6 +697,9 @@ public: // API
   }
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif /* __DALI_VECTOR_H__ */
index 13a36e6df1170b91d8891865443a8313bff804bc..035d3c7d9d8a3093ae0fc408c54f1209dd0ae334 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-common
+ * @{
+ */
 
 /**
  * @brief Templated intrusive pointer class
@@ -294,6 +298,9 @@ inline bool operator!=( T* lhs, IntrusivePtr<U>const& rhs )
   return lhs != rhs.Get();
 }
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif /* __DALI_INTRUSIVE_PTR_H__ */
index 09713d3bfe4c4d837a4dff81e3643f5fdbee34df..8c6a0264b8e6da8931c96ab50352452f2541293d 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-common
+ * @{
+ */
 
 /**
  * @brief The status during resource loading operations.
@@ -34,6 +38,9 @@ enum LoadingState
   ResourceLoadingFailed     ///< The resource failed to load
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_LOADING_STATE_H__
index 59305b686d7b229d108a1c0a9bf391dc63357de0..df283abd4b7674a1e95a46d9c3ead03a8fa42920 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-common
+ * @{
+ */
 
 namespace Internal DALI_INTERNAL
 {
@@ -310,6 +314,10 @@ public: // Not intended for application developers
   explicit DALI_INTERNAL Stage(Internal::Stage* stage);
 };
 
+/**
+ * @}
+ */
+
 } // namespace Dali
 
 #endif // __DALI_STAGE_H__
index 0fd5162071df84c3765e45bc1047f5fcbde3d84b..0d39201493e8ac373d56ca6957892f7bafd004cb 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-common
+ * @{
+ */
 
 /**
  * @brief Basic type traits that every type has by default
@@ -51,6 +55,9 @@ struct TypeTraits : public BasicTypes< Type >
 {
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif /* __DALI_TYPE_TRAITS_H__ */
index 170d0f24e47b8f3e7d9b06f31f8eeec957793b0a..fde7eb940ad96c747c9e9a8e4c47190c6c07a027 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-common
+ * @{
+ */
 
 /**
  * Stereoscopic view modes
@@ -32,6 +36,9 @@ enum ViewMode
   STEREO_INTERLACED  ///< Stereoscopic. Left/Right camera views are rendered into the framebuffer on alternate frames.
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_VIEW_MODE_H__
index 1b7ce752c3438e1f35258765e829b92d16427e62..53afc9c89b33b2677a9388e8bece07221f439e6f 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-events
+ * @{
+ */
 
 namespace Internal DALI_INTERNAL
 {
@@ -142,6 +146,9 @@ protected:
   explicit DALI_INTERNAL GestureDetector(Internal::GestureDetector* internal);
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_GESTURE_DETECTOR_H__
index 618b924cd27050e13e79469de5650eca069732f2..90a0b2c03de06653b2c56178a764fe184c7b7b57 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-events
+ * @{
+ */
 
 /**
  * @brief Base structure for different gestures that an application can receive.
@@ -113,6 +117,9 @@ protected: // Creation
 
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_GESTURE_H__
index fde089a00e20e0a160b1326cb8c61670be276292..95a7e7ad4e3d8cfe4ce165a3f48ce4b1a2fa025a 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-events
+ * @{
+ */
 
 /**
  * @brief Hover events are a collection of touch points at a specific moment in time.
@@ -88,6 +92,9 @@ struct DALI_IMPORT_API HoverEvent
   const TouchPoint& GetPoint(unsigned int point) const;
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_HOVER_EVENT_H__
index d8dd770f4fe35c8652b8194e4217be472c68e994..e20dc61a73a25a11ef170f9601454df3e991a142 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-events
+ * @{
+ */
 
 /**
  * @brief The key event structure is used to store a key press.
@@ -134,6 +138,9 @@ struct DALI_IMPORT_API KeyEvent
 
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_KEY_EVENT_H__
index d148792a8162a027f10e5b42cc88e32a9579aec4..05485291dc5db60ab06dc240f37f23f220f53d6d 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-events
+ * @{
+ */
 
 namespace Internal DALI_INTERNAL
 {
@@ -201,6 +205,9 @@ public: // Not intended for Application developers
 
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_LONG_PRESS_GESTURE_DETECTOR_H__
index 88d3b689cef4592db6fde80c635553bbbf1ba0e8..f891d9887fac39ed24b582d8f9052437bb56f12a 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-events
+ * @{
+ */
 
 /**
  * @brief A LongPressGesture is emitted when the user touches and holds the screen with the stated number of fingers.
@@ -85,6 +89,9 @@ struct DALI_IMPORT_API LongPressGesture : public Gesture
   Vector2 localPoint;
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_LONG_PRESS_GESTURE_H__
index 84fb8dc7e1affbfd741f7b4a92e12ccbb844837f..f522ba50dbaeeb0f7c1bb5b1d6cfa70bca921e4c 100644 (file)
@@ -35,6 +35,11 @@ class PanGestureDetector;
 
 struct PanGesture;
 
+/**
+ * @addtogroup dali-core-events
+ * @{
+ */
+
 /**
  * @brief This class looks for panning (or dragging) gestures.
  *
@@ -318,6 +323,10 @@ public: // Not intended for Application developers
 
 };
 
+/**
+ * @}
+ */
+
 } // namespace Dali
 
 #endif // __DALI_PAN_GESTURE_DETECTOR_H__
index d41b891b7826484cbd5695fc957c683514106201..7c76a687962dcff318449ba29488b9c014fa9c6c 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-events
+ * @{
+ */
 
 /**
  * @brief A PanGesture is emitted when the user moves one or more fingers in a particular direction.
@@ -167,6 +171,9 @@ struct DALI_IMPORT_API PanGesture: public Gesture
   float GetScreenDistance() const;
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_PAN_GESTURE_H__
index 7109ca617b199bb10e6953d2befce608da46dc76..39358ddf58b977ff1a4c7e061d71fc8268304876 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-events
+ * @{
+ */
 
 namespace Internal DALI_INTERNAL
 {
@@ -135,6 +139,9 @@ public: // Not intended for Application developers
 
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_PINCH_GESTURE_DETECTOR_H__
index 91e7efc45f4494ea326c78cbd8972ab273793843..6e82deca420045e9068900b099e8c2b807cfd93a 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-events
+ * @{
+ */
 
 /**
  * @brief A PinchGesture is emitted when the user moves two fingers towards or away from each other.
@@ -91,6 +95,9 @@ struct DALI_IMPORT_API PinchGesture: public Gesture
   Vector2 localCenterPoint;
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_PINCH_GESTURE_H__
index 5dbe936377e60757c9009ef4e057290a82182004..4b4570d5aa4837f9a7eb4e08aa2986a697a0a92a 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-events
+ * @{
+ */
 
 namespace Internal DALI_INTERNAL
 {
@@ -187,6 +191,10 @@ public: // Not intended for Application developers
   explicit DALI_INTERNAL TapGestureDetector(Internal::TapGestureDetector* internal);
 };
 
+/**
+ * @}
+ */
+
 } // namespace Dali
 
 #endif // __DALI_TAP_GESTURE_DETECTOR_H__
index a4484995684d4db3abc14dae4203d7b970addb0e..4ee84c9fcb69824423b09807917b6d8a06899665 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-events
+ * @{
+ */
 
 /**
  * @brief A TapGesture is emitted when the user taps the screen with the stated number of fingers a stated number of times.
@@ -84,6 +88,9 @@ struct DALI_IMPORT_API TapGesture : public Gesture
   Vector2 localPoint;
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_TAP_GESTURE_H__
index e61c5ff1c0fbebd44310f536a83e8e7a13a0fb60..244b2b077fa26553976a230f8899e12e44082362 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-events
+ * @{
+ */
+
 /**
  * @brief Touch events are a collection of touch points at a specific moment in time.
  *
@@ -87,6 +92,9 @@ struct DALI_IMPORT_API TouchEvent
   const TouchPoint& GetPoint(unsigned int point) const;
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_TOUCH_EVENT_H__
index 4090de5b8c1bd759597f177d2ed30965c7dbf257..c526012c997fb4f9a0cb40fd0d790e2b3be23dac 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-events
+ * @{
+ */
 
 /**
  * @brief A TouchPoint represents a point on the screen that is currently being touched
@@ -118,6 +122,9 @@ typedef std::vector<TouchPoint> TouchPointContainer; ///< Container of touch poi
 typedef TouchPointContainer::iterator TouchPointContainerIterator; ///< Iterator for Dali::TouchPointContainer
 typedef TouchPointContainer::const_iterator TouchPointContainerConstIterator; ///< Const iterator for Dali::TouchPointContainer
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_TOUCH_POINT_H__
index 7fb4c45e08d65224a4ef0733e95dc0a189068f3a..7fb5c1b3a402ef5ff818772d6d30361ef9b056da 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-events
+ * @{
+ */
 
 /**
  * @brief The wheel event structure is used to store a wheel rolling, it facilitates
@@ -132,6 +136,9 @@ struct DALI_IMPORT_API WheelEvent
 
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_WHEEL_EVENT_H__
index 51164b3c6f2b865eeede7eab19d6884267b3f508..e281d04d66493777e65805dba4ed3a7b8f13f33f 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-images
+ * @{
+ */
 
 namespace Internal DALI_INTERNAL
 {
@@ -288,6 +292,9 @@ public: // Not intended for application developers
   explicit DALI_INTERNAL BufferImage(Internal::BufferImage*);
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_BUFFER_IMAGE_H__
index 75d6aec495766471896d5130a7f17cbe020a6c5f..dfa871680ade96a6cc05d332e4c9580c62ab45e4 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-images
+ * @{
+ */
 
 namespace Internal DALI_INTERNAL
 {
@@ -150,6 +154,9 @@ public: // Not intended for application developers
   explicit DALI_INTERNAL EncodedBufferImage(Internal::EncodedBufferImage*);
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_ENCODED_BUFFER_IMAGE_H__
index 35878536e8523754734fa5cbff942e23ef2d3184..0b6d69a10c1e76fa947065945b9e6e5f3b37a10f 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-images
+ * @{
+ */
 
 namespace Internal DALI_INTERNAL
 {
@@ -163,6 +167,9 @@ public: // Not intended for application developers
   explicit DALI_INTERNAL FrameBufferImage(Internal::FrameBufferImage*);
 }; //class FrameBufferImage
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_FRAME_BUFFER_IMAGE_H__
index 9673cafcc76575a81e30ca322de2f4524ab968df..2c57b690ae655f1793fc1040f94a871d6724f116 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-images
+ * @{
+ */
 
 /**
  * @brief The integer dimensions of an image or a region of an image packed into
@@ -97,6 +101,9 @@ namespace SamplingMode
   const Type DEFAULT = BOX;
 }
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_IMAGE_OPERATIONS_H__
index 709b4a21012f48ad7eb72e37f5e2583146e05cca..2414c55ab36197bd83d2e5d6112e27c072b43fcc 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-images
+ * @{
+ */
 
 namespace Internal DALI_INTERNAL
 {
@@ -160,6 +164,9 @@ public: // Not intended for application developers
   explicit DALI_INTERNAL Image(Internal::Image*);
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_IMAGE_H__
index e189a0eda94b5477d91ee6a20a21db2e9b294a2d..bfb51e939004442d97cff952dcaf80e458bbfacd 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-images
+ * @{
+ */
 
 /**
  * @brief Abstract interface to provide platform-specific support for handling image data.
@@ -118,6 +122,9 @@ protected:
  */
 typedef IntrusivePtr<NativeImageInterface>  NativeImageInterfacePtr;
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_INTEGRATION_NATIVE_IMAGE_INTERFACE_H__
index 926069eb5be44ab81460558b321b35537aba1f08..5c1148a93d61ee10744403480236d90e8b41d1c8 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-images
+ * @{
+ */
 
 namespace Internal DALI_INTERNAL
 {
@@ -105,6 +109,9 @@ public: // Not intended for application developers
 
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_NATIVE_IMAGE_H__
index caa2e5cbfd3ff62e7d679d8f3814deb67a7e429c..fd50afe3733919ef7198da5a46fe9993ac0c971e 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-images
+ * @{
+ */
 
 namespace Internal DALI_INTERNAL
 {
 class NinePatchImage;
 }
 
-
 /**
  * @brief NinePatchImage represents an image resource that can be added to ImageActors.
  * It contains a bitmap that is synchronously loaded from the file system that contains
@@ -126,6 +129,9 @@ public: // Not intended for application developers
   explicit DALI_INTERNAL NinePatchImage(Internal::NinePatchImage*);
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_NINE_PATCH_IMAGE_H__
index cbd1d73dc5c993dd94b081552b8768d0bc320a76..7ba6f3d2b1f4055c2336cff08c7b03b26b8c10e1 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-images
+ * @{
+ */
 
 /**
  * @brief Pixel format types and their properties.
@@ -113,6 +117,9 @@ DALI_IMPORT_API void GetAlphaOffsetAndMask(Format pixelFormat, int& byteOffset,
 
 } //namespace Pixel
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_PIXEL_H__
index cf8d6fabeb306ff1857ed5b438ae21952c3c578d..150cee752187c425afcb866bd53bc1e4571d6e1b 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-images
+ * @{
+ */
 
 namespace Internal DALI_INTERNAL
 {
@@ -266,6 +270,9 @@ public: // Not intended for application developers
   explicit DALI_INTERNAL ResourceImage( Internal::ResourceImage* );
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_RESOURCE_IMAGE_H__
index 3d9f3333b0f488ad849f57e84c594cffcdb91db5..436323f30b6a66ed347e8b431dc3c9a9163c57c4 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-object
+ * @{
+ */
 
 struct Radian;
 
@@ -73,6 +77,9 @@ inline bool operator==( const Dali::AngleAxis& lhs, const Dali::AngleAxis& rhs )
   return (lhs.angle == rhs.angle) && (lhs.axis == rhs.axis);
 }
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_ANGLE_AXIS_H__
index a0f506dc84974a1cccb5078378f3478b4e1a8e64..ded916be211c7c3c86fa8741671feaf695bb8f18 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-math
+ * @{
+ */
+
 /**
  * @brief Compile time template to calculate base to the power of N.
  *
@@ -153,6 +158,9 @@ struct Epsilon< 0 >
 #endif
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_COMPILE_TIME_MATH_H__
index 292a01ced2c921a6a585482e65ccdeb625d2bc07..4eec8e2856d5f3ae715b27fa05535bba923b4391 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-math
+ * @{
+ */
 
 struct Radian;
 
@@ -103,6 +107,9 @@ inline Degree Clamp( Degree angle, float min, float max )
   return Degree( Clamp<float>( angle.degree, min, max ) );
 }
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_DEGREE_H__
index 9c6db4acf680b8655b5d009c06ca2c7e6cef1f75..47b10ea78796aec2f781eb3f036ba9b36dab58f2 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-math
+ * @{
+ */
 
 /**
  * @brief Returns the next power of two.
@@ -306,6 +310,9 @@ inline float ShortestDistanceInDomain( float a, float b, float start, float end
   return vect;
 }
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_MATH_UTILS_H__
index ab96e049c3e4ee814e590fce3ad40bcd77e19ce2..41fd3b30f83d519e03c1cf454fa517bcb60d50bd 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-math
+ * @{
+ */
+
 class Quaternion;
 
 /**
@@ -363,6 +368,9 @@ DALI_IMPORT_API std::ostream& operator<< (std::ostream& o, const Matrix& matrix)
 // Allow Matrix to be treated as a POD type
 template <> struct TypeTraits< Matrix > : public BasicTypes< Matrix > { enum { IS_TRIVIAL_TYPE = true }; };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_MATRIX_H__
index 05524aa8c379eda079b18c36ee75b63ea7770b44..e0bf2ce691dedac2d5bb5b329f8b26e17b20fb3a 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-math
+ * @{
+ */
 
 class Matrix;
 struct Vector2;
@@ -214,6 +218,9 @@ DALI_IMPORT_API std::ostream& operator<< (std::ostream& o, const Matrix3& matrix
 // Allow Matrix3 to be treated as a POD type
 template <> struct TypeTraits< Matrix3 > : public BasicTypes< Matrix3 > { enum { IS_TRIVIAL_TYPE = true }; };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif //__DALI_MATRIX3_H__
index 7f8b8457741ccb3002cd273f1b4f23e1793595f7..450f964badec06851ce9842735e0b559076b0f3d 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-math
+ * @{
+ */
 
 // Forward declaration
 class Matrix;
@@ -431,6 +435,9 @@ DALI_IMPORT_API std::ostream& operator<< (std::ostream& o, const Quaternion& qua
 // Allow Quaternion to be treated as a POD type
 template <> struct TypeTraits< Quaternion > : public BasicTypes< Quaternion > { enum { IS_TRIVIAL_TYPE = true }; };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_QUATERNION_H__
index 8f0e961f9aa37471785756c176f9c4f02cf24710..7fc3e64d465c555fa7d5237afcdd8dd7a095c147 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-math
+ * @{
+ */
 
 /**
  * @brief An angle in radians.
@@ -292,6 +296,9 @@ inline Radian Clamp( Radian angle, float min, float max )
   return Radian( Clamp<float>( angle.radian, min, max ) );
 }
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_RADIAN_H__
index 9b9e97e0bc10920ba771a5c6ba93e343e8ea3384..47a62719c946369a467b189aa5ebdf22eb9b5019 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-math
+ * @{
+ */
 
 /**
  * @brief Provides methods to generate and use random values.
@@ -68,6 +72,9 @@ inline Vector4 Axis()
 
 } // namespace Random
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_RANDOM_H__
index 3b73c3d276ac6e6240b2dee09967c97a0322d46a..1676e538d773faf33c5efb02775b7cf9d54c719d 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-object
+ * @{
+ */
 
 /**
  * @brief Template class to create and operate on rectangles.
  */
+
 template< typename T = float >
 struct Rect
 {
@@ -297,6 +302,9 @@ inline std::ostream& operator<< (std::ostream& stream, const Rect<T>& rectangle)
   return stream << "[" << rectangle.x << ", " << rectangle.y << ", " << rectangle.width << ", " << rectangle.height << "]";
 }
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_RECT_H__
index 649494b672b5496c6666d9a9f3a33c2a67f920d5..2e802e164b39d83896489f92e6c8c578696ab6bf 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-math
+ * @{
+ */
 
 /**
  * @brief Simple class for passing around pairs of small unsigned integers.
@@ -177,6 +181,9 @@ private:
   };
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_UINT_16_PAIR_H__
index 6806a4bd5b37bd04077f12b0ea20a6624ecea88b..68cba9764c7d84d414b771ae4cf7c5e299bcd8e2 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-math
+ * @{
+ */
 
 struct Vector3;
 struct Vector4;
@@ -471,6 +475,9 @@ DALI_IMPORT_API Vector2 Clamp( const Vector2& v, const float& min, const float&
 // Allow Vector2 to be treated as a POD type
 template <> struct TypeTraits< Vector2 > : public BasicTypes< Vector2 > { enum { IS_TRIVIAL_TYPE = true }; };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_VECTOR_2_H__
index 7dd71a2ebbbf8c21c71d249be37c14f95796e816..5d9b4716b484eaa4dc8de408878bd93c91c41aaf 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-math
+ * @{
+ */
 
 struct Vector2;
 struct Vector4;
@@ -559,6 +563,9 @@ DALI_IMPORT_API Vector3 Clamp( const Vector3& v, const float& min, const float&
 // Allow Vector3 to be treated as a POD type
 template <> struct TypeTraits< Vector3 > : public BasicTypes< Vector3 > { enum { IS_TRIVIAL_TYPE = true }; };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_VECTOR_3_H__
index 5a5950824df77e49716bfbbde41e463c4626bb92..445fafda80dea9451ec7068fb1c28986a77fc53c 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-math
+ * @{
+ */
+
 struct Vector2;
 struct Vector3;
 
@@ -564,6 +569,9 @@ DALI_IMPORT_API Vector4 Clamp( const Vector4& v, const float& min, const float&
 // Allow Vector4 to be treated as a POD type
 template <> struct TypeTraits< Vector4 > : public BasicTypes< Vector4 > { enum { IS_TRIVIAL_TYPE = true }; };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_VECTOR_4_H__
index 3d0a4bdf11987666e1cf809323fd12868da25142..4b2dc2cb7f9b7ab4930c4061d40ce4b35068c36b 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-math
+ * @{
+ */
 
 /**
  * @brief Typedef for a viewport ( a rectangle representing a screen area ).
  */
 typedef Rect<int> Viewport;
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_VIEWPORT_H__
index 4cf8668bb2f4434dc6f835b2ee467fa111a3947f..93ac32c3828c7db3471173a8e19d34b079c3a6a8 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-object
+ * @{
+ */
 
 /**
  * @brief Stores a value of any type.
@@ -454,6 +458,9 @@ inline const Type& AnyCastReference( const Any& any )
   return any.Get<Type>();
 }
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_ANY_TYPE_H__
index 42194e084d0b2206e04a0191bede39be59f3597e..2f5641a8bcbded57b7009207b6754defd3c9f34d 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-object
+ * @{
+ */
 
 class BaseObject;
 class ConnectionTrackerInterface;
@@ -278,6 +282,9 @@ inline bool operator<(const BaseHandle& lhs, const BaseHandle& rhs)
   return lhs.GetObjectPtr() < rhs.GetObjectPtr();
 }
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_BASE_HANDLE_H__
index c39f9c53ee10b5e887a8d07533b4f9cced1e5a0b..67172c36f0a67d4d76b7d1171729af49608aaf0f 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-object
+ * @{
+ */
 
 class BaseHandle;
 
@@ -132,6 +136,9 @@ inline const BaseObject& GetImplementation(const Dali::BaseHandle& handle)
   return handle.GetBaseObject();
 }
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 # endif // __DALI_BASE_OBJECT_H__
index daf7d30a736a3b298ecdd666f32bd38e00a7ed40..51fd84e2ef2c876d24505a39a15720c45366157a 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-object
+ * @{
+ */
 
 class Constraint;
 class PropertyNotification;
@@ -348,6 +352,9 @@ DALI_IMPORT_API Handle New();
 
 } // namespace WeightObject
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_HANDLE_H__
index 93fc7b7a613c06dddd25d0c65433594882128eb8..997e4fee5a3522d9cac04df5810ab9d0664d6fe4 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-object
+ * @{
+ */
 
 namespace Internal DALI_INTERNAL
 {
@@ -144,6 +148,9 @@ public: // Not intended for application developers
   explicit DALI_INTERNAL ObjectRegistry(Internal::ObjectRegistry* objectRegistry);
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_OBJECT_REGISTRY_H__
index 7a6e173df2df96aed311a182480dc703a1759299..64fa1574c8a3359fb001b3fa10d99e36c0cf2945 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-object
+ * @{
+ */
 
 /**
  * @brief A Array of property values.
@@ -169,6 +173,9 @@ private:
   Impl* mImpl; ///< Pointer to private data
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_PROPERTY_ARRAY_H__
index 9b64967f723206ed6acab3ca604bab381c2565ce..dc946ee0cd2dbe444ff84e83d9bccf462acf61ff 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-object
+ * @{
+ */
 
 namespace Internal DALI_INTERNAL
 {
@@ -167,6 +171,9 @@ DALI_IMPORT_API PropertyCondition StepCondition( float stepAmount, float initial
  */
 DALI_IMPORT_API PropertyCondition VariableStepCondition( const Dali::Vector<float>& steps );
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_PROPERTY_CONDITIONS_H__
index d3c58445820f60ea49c2592b91decf7e7b6dd7c0..3530c166732fe8fe1c59a43d9200f1bc2477d71a 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-object
+ * @{
+ */
 
 /**
  * @brief These are the property index ranges.
@@ -54,6 +58,9 @@ enum PropertyRanges
   PROPERTY_CUSTOM_START_INDEX                   = 50000000,   ///< The index at which custom properties start (SceneGraph and Event side properties per instance)
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_PROPERTY_INDEX_RANGES_H__
index 97aacb2d5ce68fd3e2aae62e97e823eaa0d442b7..7d4038bf869fdd8aefeddd432b15168996881d09 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-object
+ * @{
+ */
 
 struct Vector2;
 struct Vector3;
@@ -135,6 +139,9 @@ public:
   }
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_PROPERTY_INPUT_H__
index 8c1be41c87dd534208d60e2133de44e346c758bd..3c1840781a48d0b24d4d975c23119a49160c753c 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-object
+ * @{
+ */
+
 typedef std::pair<std::string, Property::Value> StringValuePair;
 
 /**
@@ -193,6 +198,9 @@ private:
   Impl* mImpl; ///< Pointer to private data
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_PROPERTY_MAP_H__
index 365329c7e448b6f0ef3234d6b246c89495c70be6..68afddb4892b1ba93feb00fbacfb00e5a033edcd 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-object
+ * @{
+ */
 
 class PropertyNotification;
 
@@ -32,6 +36,9 @@ class PropertyNotification;
  */
 typedef Signal< void (PropertyNotification& source) > PropertyNotifySignalType;
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_PROPERTY_NOTIFICATION_DECLARATIONS_H__
index 87995db25eeac4753db201c51c2c349a25348719..3081f4c120cc9111d19ce6c86b1a120bdae20c27 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-object
+ * @{
+ */
 
 namespace Internal DALI_INTERNAL
 {
@@ -162,6 +166,9 @@ public: // Not intended for use by Application developers
   explicit DALI_INTERNAL PropertyNotification(Internal::PropertyNotification* propertyNotification);
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_PROPERTY_NOTIFICATION_H__
index b149268b203e0c0770486d73e5f2eb18894359aa..a1e8698a43d323edfb29685e1613f35ce4b55d5f 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-object
+ * @{
+ */
 
 /**
  * @brief Template function instances for property getters.
@@ -88,6 +92,9 @@ inline Property::Type Get<Property::Array>()  { return Property::ARRAY; }
 
 }; // namespace PropertyTypes
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_PROPERTY_TYPES_H__
index 3e93d2f0bdb34dfd55a84d4207a48b4e33a8e65f..b88dd1e895d4a9cd5944765f3304653632da6822 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-object
+ * @{
+ */
 
 struct AngleAxis;
 class Quaternion;
@@ -367,6 +371,9 @@ private:
  */
 DALI_IMPORT_API std::ostream& operator<<( std::ostream& ouputStream, const Property::Value& value );
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_PROPERTY_VALUE_H__
index e7930cb9249113d502f7152a7acd33a207e46761..efd02c9ff674e4165a00d212e69f3b8560e1ceed 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-object
+ * @{
+ */
 
 class Handle;
 
@@ -147,6 +151,9 @@ struct DALI_IMPORT_API Property
   int componentIndex; ///< Index of a property sub component, for use with Vector2, Vector3 and Vector4, -1 if using main property
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_PROPERTY_H__
index 764982b367e4ab3e0c2d782c6999bb2c7b2430e0..7b47b28476277aee16247981bc7517ac4d38424d 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-object
+ * @{
+ */
 
 class Value;
 
@@ -92,6 +96,9 @@ private:
   volatile int mCount; ///< Reference count
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_REF_OBJECT_H__
index e0f3bb972823655406c61c5053501f0d41328442..625f0bf507a84055d130a7cf55ecbc64a93e568c 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-object
+ * @{
+ */
 
 class ConnectionTrackerInterface;
 class FunctorDelegate;
@@ -203,6 +207,9 @@ public: // Not intended for application developers
 
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_TYPE_INFO_H__
index 162d3ca28aed7a34db98ab9297660fdb99b7b569..8a4f28fea87e688fdcfac15314a99f7461b01b10 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-object
+ * @{
+ */
 
 namespace Internal DALI_INTERNAL
 {
@@ -335,6 +339,9 @@ public:
   AnimatablePropertyComponentRegistration( TypeRegistration& registered, const std::string& name, Property::Index index, Property::Index baseIndex, unsigned int componentIndex );
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // header
index 7e94f888206b1f717925d6b40d3cfaed40221e31..5b363a78f5674ae24576de2d041eb60b8763ae9a 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-render-tasks
+ * @{
+ */
 
 class RenderTask;
 
@@ -120,6 +124,9 @@ public: // Not intended for application developers
   explicit DALI_INTERNAL RenderTaskList( Internal::RenderTaskList* renderTask );
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif //__DALI_RENDER_TASK_LIST_H__
index ea3600eb4edeb656e9ab757cdad4da75edd2135b..9094f5a3996181c9f1e7e3acea67d967cccdb15d 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-render-tasks
+ * @{
+ */
 
 class Actor;
 class CameraActor;
@@ -414,6 +418,9 @@ public: // Not intended for application developers
   explicit DALI_INTERNAL RenderTask( Internal::RenderTask* renderTask );
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif //__DALI_RENDER_TASK_H__
index ad1282ec1c6b50982f1cf552bedab25b221fa32f..bcedc875c5c751daf27d80574a9dd499ed38729e 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-shader-effects
+ * @{
+ */
 
 /**
  * @brief DALI_COMPOSE_SHADER macro provides a convenient way to write shader source code.
@@ -334,6 +338,9 @@ public: // Not intended for application developers
   explicit DALI_INTERNAL ShaderEffect(Internal::ShaderEffect* effect);
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_SHADER_EFFECT_H__
index b468e45a20e7548cf7e142c1e8c73e914dd96f96..41c910d5b6546dd1411a9e8cfaed2d5c117891a1 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-signals
+ * @{
+ */
 
 /**
  * @brief Implementation class for Dali::Signal.
@@ -492,6 +496,9 @@ private:
   bool mEmittingFlag; ///< Used to guard against nested Emit() calls
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_BASE_SIGNAL_H__
index ed705394c6c608e65119434373b7ddf378bee951..6f556eea339c60c177959d0672cefcdead53cc1c 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-signals
+ * @{
+ */
 
 class CallbackBase;
 
@@ -1637,6 +1641,9 @@ inline CallbackBase* MakeCallback( T& object, void(Base::*function)(void) )
   return new Callback< T >( object, function );
 }
 
+/**
+ * @}
+ */
 } // namespace DALI
 
 #endif // __DALI_CALLBACK_H__
index 0e5de5545247996aa2962fb61dd88e61b21ce6fa..818c2f3143aef2117b913e56e3ecf7fb727c374a 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-signals
+ * @{
+ */
 
 /**
  * @brief Interface used to track connections between signals and slots.
@@ -74,6 +78,9 @@ private:
   ConnectionTrackerInterface& operator=( const ConnectionTrackerInterface& ); ///< undefined assignment operator
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_CONNECTION_TRACKER_INTERFACE_H__
index 81022dc15cea6e75f1b43127a5d898f96e10688c..741eb279a84465863cb17e20ce3ea8d9130f3b6c 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-signals
+ * @{
+ */
 
 class CallbackBase;
 class SlotObserver;
@@ -78,6 +82,9 @@ private:
   Dali::Vector< SlotConnection* > mConnections; ///< Vector of connection pointers
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_CONNECTION_TRACKER_H__
index 03a8354b8a96e80404260553a0d4b11045d8dd37..a4284d823d04b4eb825250c5e80b510303ee8f53 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-signals
+ * @{
+ */
 
 /**
  * @brief Base Template class to provide signals.
@@ -1365,6 +1369,9 @@ private:
   BaseSignal mImpl; ///< Implementation
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_SIGNAL_H__
index dafcf388a77185f75cb73ecbe6e2595b4af4cd2b..d541abab265a91808e83aedfe86e195170817d94 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-signals
+ * @{
+ */
 
 /**
  * @brief Dispatcher to call a functor
@@ -129,6 +133,9 @@ public: // Data for deriving classes & Dispatchers
   Destructor mDestructorDispatcher;     ///< Destructor for owned objects
 };
 
+/**
+ * @}
+ */
 } // namespace DALI
 
 #endif // __DALI_FUNCTOR_DELEGATE_H__
index b5f65ddfa88bd3a031ff202de22d495acc5cd767..ec51d87d07240f01148880bf1907d4c3911e0b7a 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-signals
+ * @{
+ */
 
 class CallbackBase;
 
@@ -142,6 +146,9 @@ private:
   CallbackBase* mCallback;         ///< The callback, has ownership.
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_SIGNAL_SLOT_CONNECTIONS_H__
index fea98e526a2774483520339fb952d2e9584d2dd8..5af5a8ee5dab5c3ce472aa05a343d86301a421ab 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-signals
+ * @{
+ */
 
 class SlotObserver;
 class CallbackBase;
@@ -82,6 +86,9 @@ public:
   virtual void SlotDisconnected( CallbackBase* callback ) = 0;
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_SIGNAL_SLOT_OBSERVERS_H__
index a48d7833c0d34a9e27e94894b30821d1382be66e..9bf93ae8308fa43de3b7f5c5a522491786d8e6f3 100644 (file)
 
 namespace Dali
 {
+/**
+ * @addtogroup dali-core-signals
+ * @{
+ */
 
 /**
  * @brief SlotDelegates can be used to connect member functions to signals, without inheriting from SlotDelegateInterface.
@@ -140,6 +144,9 @@ private:
   ConnectionTracker mConnectionTracker; ///< A connection tracker
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_SLOT_DELEGATE_H__
diff --git a/doc/dali-core-doc.h b/doc/dali-core-doc.h
new file mode 100644 (file)
index 0000000..267824d
--- /dev/null
@@ -0,0 +1,44 @@
+#ifndef __DALI_DOC_H__
+#define __DALI_DOC_H__
+
+/**
+ * @defgroup dali-core DALi Core
+ * @ingroup dali
+ *
+ * @brief This module provides scene graph-based rendering, animation, and event handling.
+ * It is a base module and forms the biggest part of DALi.
+ *
+ * @{
+ *   @defgroup dali-core-actors Actors
+ *   @brief Actor is the primary object for interaction in DALi applications.
+
+ *   @defgroup dali-core-animation Animation
+ *   @brief Animation allows your objects to move around / change their properties for a specified duration.
+
+ *   @defgroup dali-core-common Common
+ *   @brief Common classes for using DALi.
+
+ *   @defgroup dali-core-events Events
+ *   @brief Input events and gestures supported by DALi.
+
+ *   @defgroup dali-core-images Images
+ *   @brief Classes for handling resource images.
+
+ *   @defgroup dali-core-math Math
+ *   @brief Basic math classes.
+
+ *   @defgroup dali-core-object Object
+ *   @brief Classes for the handle/body pattern and property system.
+
+ *   @defgroup dali-core-render-tasks Render Tasks
+ *   @brief Render task classes.
+
+ *   @defgroup dali-core-shader-effects Shader Effects
+ *   @brief Shader effect classes.
+
+ *   @defgroup dali-core-signals Signals
+ *   @brief Classes for the signal and slot structure.
+ * @}
+ */
+
+#endif  /* __DALI_DOC_H__ */
diff --git a/doc/file.list b/doc/file.list
new file mode 100644 (file)
index 0000000..b0fc9e5
--- /dev/null
@@ -0,0 +1,2 @@
+package_doxy_files = \
+  $(package_doxy_dir)/dali-core-doc.h
index e20a1fb82b9d98f8321e1f725c0fdb63eff2a086..5c59db0171e171b973fe39148e865556fdefa195 100644 (file)
@@ -135,6 +135,7 @@ exit 0
 %{_libdir}/pkgconfig/*.pc
 %{dev_include_path}/%{name}/public-api/*
 %{dev_include_path}/%{name}/devel-api/*
+%{dev_include_path}/%{name}/doc/*
 
 %files integration-devel
 %defattr(-,root,root,-)