From: Yoonsang Lee Date: Thu, 23 Jul 2015 05:36:50 +0000 (+0900) Subject: Doxygen grouping X-Git-Tag: dali_1.1.2~6^2 X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=commitdiff_plain;h=07bbc876b9b069903dd4ed86c9dd5f2f66fc3b86;ds=sidebyside Doxygen grouping - Grouping using @defgroup, @ingroup, @addtogroup - Results are shown in the "Modules" tab of the generated doxygen html - Grouping comments are in doc/xxx_doc.h - Install doc/xxx_doc.h as well when conducting 'make install' Change-Id: Ie6abb5fd56df983b8d9d5fa7426d685589892d4b --- diff --git a/build/tizen/dali-toolkit/Makefile.am b/build/tizen/dali-toolkit/Makefile.am index b5ba49a..bd24d22 100644 --- a/build/tizen/dali-toolkit/Makefile.am +++ b/build/tizen/dali-toolkit/Makefile.am @@ -38,6 +38,9 @@ daliimage_DATA = ${dali_toolkit_image_files} dalisounddir = ${dataReadOnlyDir}/toolkit/sounds/ dalisound_DATA = ${dali_toolkit_sound_files} +package_doxy_dir = ../../../doc +include ../../../doc/file.list + # The library lib_LTLIBRARIES = libdali-toolkit.la @@ -155,3 +158,6 @@ publicapitextcontrols_HEADERS = $(public_api_text_controls_header_files) publicapifocusmanager_HEADERS = $(public_api_focus_manager_header_files) publicapirenderingbackend_HEADERS = $(public_api_rendering_backend_header_files) +# package doxygen file (contains doxygen grouping information) +packagedoxydir = $(topleveldir)/doc +packagedoxy_HEADERS = $(package_doxy_files) diff --git a/build/tizen/docs/dali.doxy.in b/build/tizen/docs/dali.doxy.in index 438d79d..3fa2e57 100644 --- a/build/tizen/docs/dali.doxy.in +++ b/build/tizen/docs/dali.doxy.in @@ -758,9 +758,12 @@ WARN_LOGFILE = # Note: If this tag is empty the current directory is searched. INPUT = @DOXYGEN_DOCS_DIR@/content \ + @prefix@/include/dali/doc/dali-core-doc.h \ + @prefix@/include/dali/doc/dali-adaptor-doc.h \ + ../../../../dali-toolkit/doc/dali-toolkit-doc.h \ + @prefix@/include/dali \ ../../../../dali-toolkit/dali-toolkit/public-api \ - ../../../automated-tests/README.md \ - @prefix@/include/dali + ../../../automated-tests/README.md # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses diff --git a/dali-toolkit/public-api/accessibility-manager/accessibility-manager.h b/dali-toolkit/public-api/accessibility-manager/accessibility-manager.h index 9f807ac..08ce8ce 100644 --- a/dali-toolkit/public-api/accessibility-manager/accessibility-manager.h +++ b/dali-toolkit/public-api/accessibility-manager/accessibility-manager.h @@ -32,6 +32,10 @@ namespace Internal DALI_INTERNAL { class AccessibilityManager; } +/** + * @addtogroup dali-toolkit-accessibility-manager + * @{ + */ /** * @brief Manages registration of actors in a accessibility focus chain and changing the @@ -750,6 +754,9 @@ public: }; // class AccessibilityManager +/** + * @} + */ } // namespace Toolkit } // namespace Dali diff --git a/dali-toolkit/public-api/controls/alignment/alignment.h b/dali-toolkit/public-api/controls/alignment/alignment.h index 1f34eb5..5a9d56c 100644 --- a/dali-toolkit/public-api/controls/alignment/alignment.h +++ b/dali-toolkit/public-api/controls/alignment/alignment.h @@ -31,6 +31,10 @@ namespace Internal DALI_INTERNAL { class Alignment; } +/** + * @addtogroup dali-toolkit-controls-alignment + * @{ + */ /** * @brief Alignment is a container which provides an easy way to align other actors inside its boundary. @@ -229,6 +233,9 @@ public: // Not intended for application developers explicit DALI_INTERNAL Alignment( Dali::Internal::CustomActor* internal ); }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali diff --git a/dali-toolkit/public-api/controls/buttons/button.h b/dali-toolkit/public-api/controls/buttons/button.h index 9c0eba0..f5c2701 100644 --- a/dali-toolkit/public-api/controls/buttons/button.h +++ b/dali-toolkit/public-api/controls/buttons/button.h @@ -31,6 +31,10 @@ namespace Internal DALI_INTERNAL { class Button; } +/** + * @addtogroup dali-toolkit-controls-buttons + * @{ + */ /** * @brief Button is a base class for different kind of buttons. @@ -420,6 +424,9 @@ public: // Not intended for application developers DALI_INTERNAL Button( Dali::Internal::CustomActor* internal ); }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali diff --git a/dali-toolkit/public-api/controls/buttons/check-box-button.h b/dali-toolkit/public-api/controls/buttons/check-box-button.h index 5798ef3..357c3e1 100644 --- a/dali-toolkit/public-api/controls/buttons/check-box-button.h +++ b/dali-toolkit/public-api/controls/buttons/check-box-button.h @@ -33,6 +33,10 @@ namespace Internal DALI_INTERNAL { class CheckBoxButton; } +/** + * @addtogroup dali-toolkit-controls-buttons + * @{ + */ /** * CheckBoxButton provides a check box button which user can check or uncheck. @@ -106,6 +110,9 @@ public: // Not intended for application developers DALI_INTERNAL CheckBoxButton( Dali::Internal::CustomActor* internal ); }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali diff --git a/dali-toolkit/public-api/controls/buttons/push-button.h b/dali-toolkit/public-api/controls/buttons/push-button.h index 0e53a9c..8ebbf58 100644 --- a/dali-toolkit/public-api/controls/buttons/push-button.h +++ b/dali-toolkit/public-api/controls/buttons/push-button.h @@ -35,6 +35,10 @@ namespace Internal DALI_INTERNAL class PushButton; } +/** + * @addtogroup dali-toolkit-controls-buttons + * @{ + */ /** * @brief A PushButton changes its appearance when is pressed and returns to its original when is released. @@ -193,6 +197,9 @@ public: // Not intended for application developers DALI_INTERNAL PushButton( Dali::Internal::CustomActor* internal ); }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali diff --git a/dali-toolkit/public-api/controls/buttons/radio-button.h b/dali-toolkit/public-api/controls/buttons/radio-button.h index 20ec386..7c04b42 100644 --- a/dali-toolkit/public-api/controls/buttons/radio-button.h +++ b/dali-toolkit/public-api/controls/buttons/radio-button.h @@ -35,6 +35,10 @@ namespace Internal DALI_INTERNAL class RadioButton; } +/** + * @addtogroup dali-toolkit-controls-buttons + * @{ + */ /** * @brief A RadioButton provides a radio button which two states \e selected or \e unselected. @@ -124,6 +128,9 @@ class DALI_IMPORT_API RadioButton: public Button DALI_INTERNAL RadioButton( Dali::Internal::CustomActor* internal ); }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali diff --git a/dali-toolkit/public-api/controls/control-depth-index-ranges.h b/dali-toolkit/public-api/controls/control-depth-index-ranges.h index 1a55cf2..ff5732c 100644 --- a/dali-toolkit/public-api/controls/control-depth-index-ranges.h +++ b/dali-toolkit/public-api/controls/control-depth-index-ranges.h @@ -23,6 +23,11 @@ namespace Dali { namespace Toolkit { +/** + * @addtogroup dali-toolkit-controls + * @{ + */ + enum ControlDepthIndexRanges { BACKGROUND_DEPTH_INDEX = static_cast( -Dali::Layer::TREE_DEPTH_MULTIPLIER * 0.1f ), @@ -30,6 +35,9 @@ enum ControlDepthIndexRanges DECORATION_DEPTH_INDEX = static_cast( Dali::Layer::TREE_DEPTH_MULTIPLIER * 0.1f ) }; +/** + * @} + */ } } diff --git a/dali-toolkit/public-api/controls/control-impl.h b/dali-toolkit/public-api/controls/control-impl.h index 1ce94b7..b8ae6bb 100644 --- a/dali-toolkit/public-api/controls/control-impl.h +++ b/dali-toolkit/public-api/controls/control-impl.h @@ -35,11 +35,15 @@ namespace Dali namespace Toolkit { +/** + * @addtogroup dali-toolkit-controls + * @{ + */ + class StyleManager; namespace Internal { - /** * @brief This is the internal base class for all controls. * @@ -629,6 +633,9 @@ DALI_IMPORT_API const Internal::Control& GetImplementation( const Dali::Toolkit: } // namespace Internal +/** + * @} + */ } // namespace Toolkit } // namespace Dali diff --git a/dali-toolkit/public-api/controls/control.h b/dali-toolkit/public-api/controls/control.h index 1e4d74d..35587f9 100644 --- a/dali-toolkit/public-api/controls/control.h +++ b/dali-toolkit/public-api/controls/control.h @@ -40,6 +40,10 @@ namespace Internal { class Control; } +/** + * @addtogroup dali-toolkit-controls + * @{ + */ /** * @brief Control is the base class for all controls. @@ -403,6 +407,9 @@ public: // Templates for Deriving Classes }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali diff --git a/dali-toolkit/public-api/controls/default-controls/solid-color-actor.h b/dali-toolkit/public-api/controls/default-controls/solid-color-actor.h index 23b00e2..6c88108 100644 --- a/dali-toolkit/public-api/controls/default-controls/solid-color-actor.h +++ b/dali-toolkit/public-api/controls/default-controls/solid-color-actor.h @@ -27,7 +27,6 @@ namespace Dali namespace Toolkit { - /** * @brief Creates a Dali::ImageActor with a solid color, optionally it creates a border. * @@ -40,7 +39,6 @@ namespace Toolkit * @return a handle to the new ImageActor */ DALI_IMPORT_API ImageActor CreateSolidColorActor( const Vector4& color, bool border = false, const Vector4& borderColor = Color::WHITE, const unsigned int borderSize = 1 ); - } // namespace Toolkit } // namespace Dali diff --git a/dali-toolkit/public-api/controls/gaussian-blur-view/gaussian-blur-view.h b/dali-toolkit/public-api/controls/gaussian-blur-view/gaussian-blur-view.h index e6a32b8..a2c5ea6 100644 --- a/dali-toolkit/public-api/controls/gaussian-blur-view/gaussian-blur-view.h +++ b/dali-toolkit/public-api/controls/gaussian-blur-view/gaussian-blur-view.h @@ -49,6 +49,10 @@ class GaussianBlurView; class BloomView; } // namespace Internal +/** + * @addtogroup dali-toolkit-controls-gaussian-blur-view + * @{ + */ /** * @@ -274,6 +278,9 @@ public: }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali diff --git a/dali-toolkit/public-api/controls/image-view/image-view.h b/dali-toolkit/public-api/controls/image-view/image-view.h index 821a981..fe6d7b1 100644 --- a/dali-toolkit/public-api/controls/image-view/image-view.h +++ b/dali-toolkit/public-api/controls/image-view/image-view.h @@ -31,6 +31,10 @@ namespace Internal DALI_INTERNAL { class ImageView; } +/** + * @addtogroup dali-toolkit-controls-image-view + * @{ + */ /** * @@ -157,6 +161,9 @@ public: // Not intended for application developers }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali diff --git a/dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h b/dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h index 5da66a5..3f1ad10 100755 --- a/dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h +++ b/dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h @@ -33,6 +33,10 @@ namespace Internal DALI_INTERNAL class ScrollBar; } +/** + * @addtogroup dali-toolkit-controls-scroll-bar + * @{ + */ /** * ScrollBar is a UI component that can be linked to the scrollable objects @@ -323,11 +327,11 @@ public: // Not intended for application developers explicit DALI_INTERNAL ScrollBar( Dali::Internal::CustomActor* internal ); }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali -/** - * @} - */ #endif // __DALI_TOOLKIT_SCROLL_BAR_H__ diff --git a/dali-toolkit/public-api/controls/scrollable/item-view/default-item-layout.h b/dali-toolkit/public-api/controls/scrollable/item-view/default-item-layout.h index 6f4eb00..8299d84 100644 --- a/dali-toolkit/public-api/controls/scrollable/item-view/default-item-layout.h +++ b/dali-toolkit/public-api/controls/scrollable/item-view/default-item-layout.h @@ -26,6 +26,10 @@ namespace Dali namespace Toolkit { +/** + * @addtogroup dali-toolkit-controls-item-view + * @{ + */ namespace DefaultItemLayout { @@ -49,6 +53,9 @@ DALI_IMPORT_API ItemLayoutPtr New( Type type ); } // namespace DefaultItemLayout +/** + * @} + */ } // namespace Toolkit } // namespace Dali diff --git a/dali-toolkit/public-api/controls/scrollable/item-view/item-factory.h b/dali-toolkit/public-api/controls/scrollable/item-view/item-factory.h index d018716..84ef7b7 100644 --- a/dali-toolkit/public-api/controls/scrollable/item-view/item-factory.h +++ b/dali-toolkit/public-api/controls/scrollable/item-view/item-factory.h @@ -26,6 +26,10 @@ namespace Dali namespace Toolkit { +/** + * @addtogroup dali-toolkit-controls-item-view + * @{ + */ /** * @brief ItemFactory is for providing actors to ItemView. @@ -77,6 +81,9 @@ public: } }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali diff --git a/dali-toolkit/public-api/controls/scrollable/item-view/item-layout.h b/dali-toolkit/public-api/controls/scrollable/item-view/item-layout.h index 39370ac..9302e8a 100644 --- a/dali-toolkit/public-api/controls/scrollable/item-view/item-layout.h +++ b/dali-toolkit/public-api/controls/scrollable/item-view/item-layout.h @@ -30,6 +30,10 @@ namespace Dali namespace Toolkit { +/** + * @addtogroup dali-toolkit-controls-item-view + * @{ + */ class ItemLayout; @@ -364,6 +368,9 @@ protected: Impl* mImpl; }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali diff --git a/dali-toolkit/public-api/controls/scrollable/item-view/item-view-declarations.h b/dali-toolkit/public-api/controls/scrollable/item-view/item-view-declarations.h index 7772d45..7388bfa 100644 --- a/dali-toolkit/public-api/controls/scrollable/item-view/item-view-declarations.h +++ b/dali-toolkit/public-api/controls/scrollable/item-view/item-view-declarations.h @@ -28,6 +28,10 @@ namespace Dali namespace Toolkit { +/** + * @addtogroup dali-toolkit-controls-item-view + * @{ + */ typedef unsigned int ItemId; ///< Unique identity for each item in the view. @@ -44,6 +48,9 @@ typedef ItemContainer::const_iterator ConstItemIter; class ItemView; class ItemLayout; +/** + * @} + */ } // namespace Toolkit } // namespace Dali diff --git a/dali-toolkit/public-api/controls/scrollable/item-view/item-view.h b/dali-toolkit/public-api/controls/scrollable/item-view/item-view.h index cb0859d..2790194 100644 --- a/dali-toolkit/public-api/controls/scrollable/item-view/item-view.h +++ b/dali-toolkit/public-api/controls/scrollable/item-view/item-view.h @@ -34,6 +34,10 @@ namespace Internal DALI_INTERNAL { class ItemView; } +/** + * @addtogroup dali-toolkit-controls-item-view + * @{ + */ class ItemFactory; class ItemLayout; @@ -462,6 +466,9 @@ public: // Not intended for application developers explicit DALI_INTERNAL ItemView( Dali::Internal::CustomActor* internal ); }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali diff --git a/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-constraints.h b/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-constraints.h index 40a1f45..15a29d6 100644 --- a/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-constraints.h +++ b/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-constraints.h @@ -31,6 +31,10 @@ class PropertyInput; namespace Toolkit { +/** + * @addtogroup dali-toolkit-controls-scroll-view + * @{ + */ // Constraints //////////////////////////////////////////////////////////////////////////////////// @@ -52,6 +56,9 @@ DALI_IMPORT_API void MoveActorConstraint( Vector3& current, const PropertyInputC */ DALI_IMPORT_API void WrapActorConstraint( Vector3& position, const PropertyInputContainer& inputs ); +/** + * @} + */ } // namespace Toolkit } // namespace Dali diff --git a/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-effect.h b/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-effect.h index 1295861..4af0442 100644 --- a/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-effect.h +++ b/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-effect.h @@ -37,6 +37,10 @@ namespace Internal DALI_INTERNAL class ScrollViewEffect; class ScrollViewWobbleEffect; } +/** + * @addtogroup dali-toolkit-controls-scroll-view + * @{ + */ class ScrollView; class ScrollViewEffect; @@ -73,6 +77,9 @@ public: // Not intended for application developers }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali diff --git a/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-page-path-effect.h b/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-page-path-effect.h index de7c649..af59f83 100644 --- a/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-page-path-effect.h +++ b/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-page-path-effect.h @@ -34,6 +34,10 @@ namespace Internal DALI_INTERNAL { class ScrollViewPagePathEffect; } +/** + * @addtogroup dali-toolkit-controls-scroll-view + * @{ + */ /** * ScrollView Page Path Effect. @@ -103,6 +107,9 @@ protected: }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali diff --git a/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h b/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h index fb9d5cb..508b3d2 100644 --- a/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h +++ b/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h @@ -34,6 +34,10 @@ namespace Internal DALI_INTERNAL { class ScrollView; } +/** + * @addtogroup dali-toolkit-controls-scroll-view + * @{ + */ /** * @brief How axes/rotation or scale are clamped @@ -1136,6 +1140,9 @@ public: // Not intended for application developers explicit DALI_INTERNAL ScrollView( Dali::Internal::CustomActor* internal ); }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali diff --git a/dali-toolkit/public-api/controls/scrollable/scrollable.h b/dali-toolkit/public-api/controls/scrollable/scrollable.h index b262212..d43a29a 100644 --- a/dali-toolkit/public-api/controls/scrollable/scrollable.h +++ b/dali-toolkit/public-api/controls/scrollable/scrollable.h @@ -31,6 +31,10 @@ namespace Internal DALI_INTERNAL { class Scrollable; } +/** + * @addtogroup dali-toolkit-controls-scrollable + * @{ + */ /** * @brief Base class for derived Scrollables that contains actors that can be scrolled manually @@ -229,6 +233,9 @@ public: // Not intended for application developers explicit DALI_INTERNAL Scrollable( Dali::Internal::CustomActor* internal ); }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali diff --git a/dali-toolkit/public-api/controls/table-view/table-view.h b/dali-toolkit/public-api/controls/table-view/table-view.h index c3f0545..eb03b9e 100644 --- a/dali-toolkit/public-api/controls/table-view/table-view.h +++ b/dali-toolkit/public-api/controls/table-view/table-view.h @@ -35,6 +35,10 @@ namespace Internal DALI_INTERNAL { class TableView; } +/** + * @addtogroup dali-toolkit-controls-table-view + * @{ + */ /** * @brief TableView is a layout container for aligning child actors in a grid like layout. @@ -441,6 +445,9 @@ public: // Not intended for application developers explicit DALI_INTERNAL TableView( Dali::Internal::CustomActor* internal ); }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali diff --git a/dali-toolkit/public-api/controls/text-controls/text-field.h b/dali-toolkit/public-api/controls/text-controls/text-field.h index eacee82..5ef4432 100644 --- a/dali-toolkit/public-api/controls/text-controls/text-field.h +++ b/dali-toolkit/public-api/controls/text-controls/text-field.h @@ -31,6 +31,10 @@ namespace Internal DALI_INTERNAL { class TextField; } +/** + * @addtogroup dali-toolkit-controls-text-controls + * @{ + */ /** * @brief A control which provides a single-line editable text field. @@ -201,6 +205,9 @@ public: // Not intended for application developers explicit DALI_INTERNAL TextField( Dali::Internal::CustomActor* internal ); }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali diff --git a/dali-toolkit/public-api/controls/text-controls/text-label.h b/dali-toolkit/public-api/controls/text-controls/text-label.h index b11bd13..592cfed 100644 --- a/dali-toolkit/public-api/controls/text-controls/text-label.h +++ b/dali-toolkit/public-api/controls/text-controls/text-label.h @@ -31,6 +31,10 @@ namespace Internal DALI_INTERNAL { class TextLabel; } +/** + * @addtogroup dali-toolkit-controls-text-controls + * @{ + */ /** * @brief A control which renders a short text string. @@ -144,6 +148,9 @@ public: // Not intended for application developers explicit DALI_INTERNAL TextLabel( Dali::Internal::CustomActor* internal ); }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali diff --git a/dali-toolkit/public-api/enums.h b/dali-toolkit/public-api/enums.h index 5582ba3..ff678a9 100644 --- a/dali-toolkit/public-api/enums.h +++ b/dali-toolkit/public-api/enums.h @@ -23,12 +23,15 @@ namespace Dali { - /** * @brief DALi Toolkit namespace. */ namespace Toolkit { +/** + * @addtogroup dali-toolkit-controls + * @{ + */ /** * @brief Control Orientation namespace. @@ -65,6 +68,9 @@ DALI_IMPORT_API bool IsVertical(ControlOrientation::Type orientation); */ DALI_IMPORT_API bool IsHorizontal(ControlOrientation::Type orientation); +/** + * @} + */ } // namespace Toolkit } // namespace Dali diff --git a/dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h b/dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h index 3383a47..3b6b33f 100644 --- a/dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h +++ b/dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h @@ -31,6 +31,10 @@ namespace Internal DALI_INTERNAL { class KeyboardFocusManager; } +/** + * @addtogroup dali-toolkit-focus-manager + * @{ + */ /** * @brief Provides the functionality of handling keyboard navigation @@ -273,6 +277,9 @@ public: // Signals }; // class KeyboardFocusManager +/** + * @} + */ } // namespace Toolkit } // namespace Dali diff --git a/doc/dali-toolkit-doc.h b/doc/dali-toolkit-doc.h new file mode 100644 index 0000000..2cb0f1a --- /dev/null +++ b/doc/dali-toolkit-doc.h @@ -0,0 +1,75 @@ +#ifndef __DALI_TOOLKIT_DOC_H__ +#define __DALI_TOOLKIT_DOC_H__ + +/** + * @defgroup dali DALi + * @ingroup CAPI_UI_FRAMEWORK + * + * @brief DALi is a cross-platform 3D UI Toolkit for embedded systems. + * + * @section dali-overview Overview + * DALi's 3D user interface engine enables you to create rich and high-performance + * UI applications. DALi is based on OpenGL ES 2.0, but provides a clean + * cross-platform C++ framework. + * This means that you can use high-level DALi APIs instead of accessing + * low-level OpenGL APIs directly. + *
    + *
  • DALi Core: This module provides scene graph-based rendering, animation, and event handling.
  • + *
  • DALi Adaptor: This module is a platform adaptation layer.
  • + *
  • DALi Toolkit: This module provides UI components and various effects on top of the dali-core.
  • + *
+ * + * @defgroup dali-toolkit DALi Toolkit + * @ingroup dali + * + * @brief This module provides UI components and various effects on top of the dali-core. + * + * @{ + * @defgroup dali-toolkit-accessibility-manager Accessibility Manager + * @brief AccessibilityManager manages a accessibility focus chain. + + * @defgroup dali-toolkit-controls Controls + * @brief Controls are interactive components for layouting the user interface. + + * @{ + * @defgroup dali-toolkit-controls-alignment Alignment + * @brief Alignment is a container which provides an easy way to align other actors inside its boundary. + + * @defgroup dali-toolkit-controls-buttons Buttons + * @brief Button is a small object on UI that you can press. + + * @defgroup dali-toolkit-controls-gaussian-blur-view Gaussian Blur View + * @brief GaussianBlurView provides a render process that blurs an image. + + * @defgroup dali-toolkit-controls-image-view Image View + * @brief ImageView is a control displying an image. + + * @defgroup dali-toolkit-controls-scroll-bar Scroll Bar + * @brief ScrollBar control. + + * @defgroup dali-toolkit-controls-scrollable Scrollable + * @brief Scrollable container controls. + + * @{ + * @defgroup dali-toolkit-controls-item-view Item View + * @brief ItemView class is a scrollable container that can contain many items. + + * @defgroup dali-toolkit-controls-scroll-view Scroll View + * @brief ScrollView class provides scrollable view which contains actors and can be scrolled automatically or manually by panning. + + * @} + * @defgroup dali-toolkit-controls-table-view Table View + * @brief TableView class is a layout container for aligning child actors in a grid like layout. + + * @defgroup dali-toolkit-controls-text-controls Text Controls + * @brief Controls for displaying text or text input. + + * @} + * @defgroup dali-toolkit-focus-manager Focus Manager + * @brief Classes for handling keyboard navigation and maintaining the two dimensional keyboard focus chain. + + * @} + */ + + +#endif /* __DALI_TOOLKIT_DOC_H__ */ diff --git a/doc/file.list b/doc/file.list new file mode 100644 index 0000000..f9681c1 --- /dev/null +++ b/doc/file.list @@ -0,0 +1,3 @@ +package_doxy_files = \ + $(package_doxy_dir)/dali-toolkit-doc.h +