TizenRefApp-9381 Add doxygen documentation

Change-Id: I83ab49d23b7fed730af757dda657ec9cdd156e65
Signed-off-by: Evgen Servetnik <e.servetnik@samsung.com>

diff --git a/src/App/inc/MainLayout.h b/src/App/inc/MainLayout.h
index 7e9b07a..157bc79 100644 (file)
--- a/src/App/inc/MainLayout.h
+++ b/src/App/inc/MainLayout.h
@@ -20,15 +20,32 @@
 #include "View.h"
 
 namespace TaskMngr {
+
        class MainLayout
                : public View {
+
                public:
                        MainLayout(Evas_Object *parent);
                        virtual ~MainLayout();
-
+                       /**
+                        * @brief Set given object as list content
+                        * @param[in] pointer to evas obj
+                        */
                        void setList(Evas_Object *obj);
+                       /**
+                        * @brief Set given object as list content
+                        * @param[in] pointer to evas obj
+                        */
                        void setIndex(Evas_Object *obj);
+                       /**
+                        * @brief Show no content item
+                        * @param[in] show true to show, false otherwise
+                        */
                        void showNoContents(bool show);
+                       /**
+                        * @brief Show/hide close button
+                        * @param[in] show true to show, false otherwise
+                        */
                        void showCloseButton(bool show);
 
                protected:

diff --git a/src/App/inc/TaskListView.h b/src/App/inc/TaskListView.h
index 0b32783..47d2343 100644 (file)
--- a/src/App/inc/TaskListView.h
+++ b/src/App/inc/TaskListView.h
@@ -36,14 +36,46 @@ namespace TaskMngr
                        TaskListView(Evas_Object *parent);
                        virtual ~TaskListView();
 
+                       /**
+                        * @brief Get all items
+                        */
                        void scrollToStart();
+                       /**
+                        * @brief Set given pointer as listener
+                        * @param[in] pointer to listener and nullptr for unset
+                        */
                        void setListener(ITaskListViewListener *listener);
+                       /**
+                        * @brief Add given item to list
+                        */
                        void appendItem(TaskListViewItem &item);
+                       /**
+                        * @brief Get all items
+                        * @return vector of items
+                        */
                        std::vector<TaskListViewItem*> getItems() const;
+                       /**
+                        * @brief Counts number of items
+                        * @return number of items
+                        */
                        int getItemsCount() const;
+                       /**
+                        * @brief Current page index
+                        * @return index int value
+                        */
                        int getCurrentPageIndex() const;
+                       /**
+                        * @brief Current page item
+                        * @return Pointer to TaskListViewItem or nullptr
+                        */
                        TaskListViewItem *getCurrentPage() const;
+                       /**
+                        * @brief Call kill animation for all apps
+                        */
                        void killAll();
+                       /**
+                        * @brief Free resources for all apps
+                        */
                        void clear();
 
                private:

diff --git a/src/App/inc/TaskListViewItem.h b/src/App/inc/TaskListViewItem.h
index 697709f..af5b396 100644 (file)
--- a/src/App/inc/TaskListViewItem.h
+++ b/src/App/inc/TaskListViewItem.h
@@ -33,11 +33,26 @@ namespace TaskMngr
                        static int getWidth();
                        static int getHeight();
 
+                       /**
+                        * @brief Show animation for one app removed from TaskList
+                        */
                        void playKillAnim();
+                       /**
+                        * @brief Show animation for all apps removed from TaskList
+                        */
                        void playKillAllAnim();
+                       /**
+                        * @brief Show play up animation for one app removed from TaskList
+                        */
                        void playKillUpAnim();
+                       /**
+                        * @brief Show play down animation for one app removed from TaskList
+                        */
                        void playKillDownAnim();
                        const AppInfo &getAppInfo() const;
+                       /**
+                        * @brief Highlight Icon for screenreader
+                        */
                        void highlightIcon();
 
                private: