TizenRefApp-6802 Prepare documentation for calendar/src/settings

Change-Id: Ib98790d1b71255c3fc75747e676ffaabde565527
Signed-off-by: Sergei Kobec <s.kobec@samsung.com>

diff --git a/main-app/src/setting/CalDialogSettingsMultilSubItem.h b/main-app/src/setting/CalDialogSettingsMultilSubItem.h
index c53c689..285b298 100644 (file)
--- a/main-app/src/setting/CalDialogSettingsMultilSubItem.h
+++ b/main-app/src/setting/CalDialogSettingsMultilSubItem.h
@@ -21,13 +21,35 @@
 #include "CalCommon.h"
 #include "CalDialogControl.h"
 
+/**
+ * @brief Multiline genlist item in calendar settings
+ */
 class CalDialogSettingsMultilSubItem : public CalDialogControl::Item
 {
 public:
+       /**
+        * @brief Create item
+        *
+        * @param selectCb Select callback
+        * @param text     Text displayed in item
+        */
        CalDialogSettingsMultilSubItem(std::function<void (void)> selectCb, const char *text);
+
+       /**
+        * @brief Default constuctor
+        */
        CalDialogSettingsMultilSubItem();
+
+       /**
+        * @brief Destructor
+        */
        virtual ~CalDialogSettingsMultilSubItem();
-public:
+
+       /**
+        * @brief Set text to item
+        *
+        * @param text Text that should be displayed in item
+        */
        void setText(const char* text);
 private:
        WDISABLE_COPY_AND_ASSIGN(CalDialogSettingsMultilSubItem);

diff --git a/main-app/src/setting/CalDialogSettingsOneTextOneIconItem.h b/main-app/src/setting/CalDialogSettingsOneTextOneIconItem.h
index e9ed130..6bb669b 100644 (file)
--- a/main-app/src/setting/CalDialogSettingsOneTextOneIconItem.h
+++ b/main-app/src/setting/CalDialogSettingsOneTextOneIconItem.h
@@ -21,15 +21,50 @@
 #include "CalCommon.h"
 #include "CalDialogControl.h"
 
+/**
+ * @brief Genlist item with text and icon in calendar settings
+ */
 class CalDialogSettingsOneTextOneIconItem: public CalDialogControl::Item
 {
 public:
+       /**
+        * @brief Create item with icon and text
+        *
+        * @param selectCb Select callback
+        * @param Text     Text that appears in item
+        */
        CalDialogSettingsOneTextOneIconItem(std::function<void (void)> selectCb, const char* Text);
+
+       /**
+        * @brief Default constructor
+        */
        CalDialogSettingsOneTextOneIconItem();
+
+       /**
+        * @brief Destructor
+        */
        virtual ~CalDialogSettingsOneTextOneIconItem();
+
+       /**
+        * @brief Set radio button check callback
+        *
+        * @param radioCb Check callback
+        */
        void setRadioCb(std::function<void (void)> radioCb);
+
 public:
+       /**
+        * @brief Set item text
+        *
+        * @param text Item text
+        */
        void setText(const char* text);
+
+       /**
+        * @brief Get item content
+        *
+        * @return content on success, otherwise NULL
+        */
        Evas_Object * getIconObject();
 private:
        WDISABLE_COPY_AND_ASSIGN(CalDialogSettingsOneTextOneIconItem);

diff --git a/main-app/src/setting/CalDialogSettingsRadioItem.h b/main-app/src/setting/CalDialogSettingsRadioItem.h
index 8349f1e..4a72ab7 100644 (file)
--- a/main-app/src/setting/CalDialogSettingsRadioItem.h
+++ b/main-app/src/setting/CalDialogSettingsRadioItem.h
@@ -20,9 +20,15 @@
 
 #include "CalDialogControl.h"
 
+/**
+ * @brief Radio item in calendar settings
+ */
 class CalDialogSettingsRadioItem : public CalDialogControl::Item
 {
 public:
+       /**
+        * @brief Sub item type
+        */
        enum sub_item_type
        {
                SUB_LOCALE_DEFAULT = 0,
@@ -33,15 +39,44 @@ public:
                SUB_NOTIFICATION,
                SUB_OFF,
        };
+
+       /**
+        * @brief Settings radio item constructor
+        *
+        * @param selectCb   Select callback
+        * @param type Sub   item type
+        * @param radioIndex Radio item index
+        */
        CalDialogSettingsRadioItem(std::function<void (void)> selectCb, sub_item_type type, int radioIndex);
+
+       /**
+        * @brief Destructor
+        */
        virtual ~CalDialogSettingsRadioItem();
+
+       /**
+        * @brief Set radio item check callback
+        *
+        * @param radioCb Radio item callback
+        */
        void setRadioCb(std::function<void (void)> radioCb);
 private:
        WDISABLE_COPY_AND_ASSIGN(CalDialogSettingsRadioItem);
        virtual void onSelect();
        virtual Elm_Genlist_Item_Class* getItemClassStatic();
 public:
+       /**
+        * @brief Get sub item type
+        *
+        * @return Sub item type
+        */
        sub_item_type getSubItemType();
+
+       /**
+        * @brief Get item's radio object
+        *
+        * @return Item object on success, otherwise NULL
+        */
        Evas_Object *  getItemRadioObject();
 private:
        int __radioIndex;

diff --git a/main-app/src/setting/CalDialogSettingsTwoTextItem.h b/main-app/src/setting/CalDialogSettingsTwoTextItem.h
index 98e70c3..650c6c3 100644 (file)
--- a/main-app/src/setting/CalDialogSettingsTwoTextItem.h
+++ b/main-app/src/setting/CalDialogSettingsTwoTextItem.h
@@ -21,9 +21,15 @@
 #include "CalCommon.h"
 #include "CalDialogControl.h"
 
+/**
+ * @brief Two text item in calendar's settings dialog
+ */
 class CalDialogSettingsTwoTextItem : public CalDialogControl::Item
 {
 public:
+       /**
+        * @brief Sub item type
+        */
        enum sub_item_type
        {
                SUB_FIRST_DAY_OF_WEEK = 0,
@@ -32,11 +38,39 @@ public:
                SUB_REMINDER_TYPE,
                SUB_NOTIFICATION_SOUND,
        };
+
+       /**
+        * @brief Construct two text item
+        *
+        * @param selectCb Select callback
+        * @param mainText Main text
+        * @param subText  Sub text
+        * @param type Sub item type
+        */
        CalDialogSettingsTwoTextItem(std::function<void (void)> selectCb, const char* mainText, const char* subText, sub_item_type type);
+
+       /**
+        * @brief Default constructor
+        */
        CalDialogSettingsTwoTextItem();
+
+       /**
+        * @brief Destructor
+        */
        virtual ~CalDialogSettingsTwoTextItem();
 public:
+       /**
+        * @brief Set main text
+        *
+        * @param text Main text
+        */
        void setMainText(const char* text);
+
+       /**
+        * @brief Set sub text
+        *
+        * @param text Sub text
+        */
        void setSubText(const char* text);
 private:
        WDISABLE_COPY_AND_ASSIGN(CalDialogSettingsTwoTextItem);

diff --git a/main-app/src/setting/CalSettingAlertPopup.h b/main-app/src/setting/CalSettingAlertPopup.h
index d132336..c835e3c 100644 (file)
--- a/main-app/src/setting/CalSettingAlertPopup.h
+++ b/main-app/src/setting/CalSettingAlertPopup.h
@@ -23,11 +23,22 @@
 #include "CalCommon.h"
 #include "WPopup.h"
 
-
+/**
+ * @brief Calendar settings alert popup
+ */
 class CalSettingAlertPopup: public WPopup
 {
 public:
+       /**
+        * @brief Construct alert popup
+        *
+        * @param callbackFun Popup callback
+        */
        CalSettingAlertPopup(std::function<void ()> callbackFun);
+
+       /**
+        * @brief Destructor
+        */
        virtual ~CalSettingAlertPopup();
 private:
        static void __dialogDeleteCallback(void *data, Evas *e, Evas_Object *obj, void *event_info);

diff --git a/main-app/src/setting/CalSettingFirstDayOfWeekPopup.h b/main-app/src/setting/CalSettingFirstDayOfWeekPopup.h
index 1f5df61..883ec5e 100644 (file)
--- a/main-app/src/setting/CalSettingFirstDayOfWeekPopup.h
+++ b/main-app/src/setting/CalSettingFirstDayOfWeekPopup.h
@@ -23,11 +23,22 @@
 #include "CalCommon.h"
 #include "WPopup.h"
 
-
+/**
+ * @brief Popup to choose first day of the week
+ */
 class CalSettingFirstDayOfWeekPopup: public WPopup
 {
 public:
+       /**
+        * @brief Create popup
+        *
+        * @param callbackFun Popup item select callback
+        */
        CalSettingFirstDayOfWeekPopup (std::function<void ()> callbackFun);
+
+       /**
+        * @brief Destructor
+        */
        virtual ~CalSettingFirstDayOfWeekPopup();
 private:
        static void __dialogDeleteCallback(void *data, Evas *e, Evas_Object *obj, void *event_info);

diff --git a/main-app/src/setting/CalSettingsView.h b/main-app/src/setting/CalSettingsView.h
index 74f72a9..24dd93d 100644 (file)
--- a/main-app/src/setting/CalSettingsView.h
+++ b/main-app/src/setting/CalSettingsView.h
@@ -25,11 +25,20 @@
 #include "CalDialogSettingsTwoTextItem.h"
 #include "CalDialogSettingsOneTextOneIconItem.h"
 
-
+/**
+ * @brief Calendar settings view
+ */
 class CalSettingsView  : public CalView
 {
 public:
+       /**
+        * @brief Create calendar settings view
+        */
        CalSettingsView();
+
+       /**
+        * @brief Destructor
+        */
        virtual ~CalSettingsView();
 
 private:
@@ -37,6 +46,9 @@ private:
 
 private:
 
+       /**
+        * @brief Setting select type
+        */
        enum SettingSelectType
        {
                SETTING_FIRST_DAY_OF_WEEK_SELECT = 0,