doc: clear all doxygen warnings 96/108796/2
authorLukasz Stanislawski <l.stanislaws@samsung.com>
Thu, 5 Jan 2017 17:17:37 +0000 (18:17 +0100)
committerLukasz Stanislawski <l.stanislaws@samsung.com>
Mon, 9 Jan 2017 09:15:47 +0000 (10:15 +0100)
Change-Id: I76ebffbe64d1ab9af2ddb38e8c0158ccb675313d

17 files changed:
clock/inc/Controller/MainController.h
clock/inc/Model/Location.h
clock/inc/Model/RingEvent.h
clock/inc/Model/WorldClock.h
clock/inc/Presenter/WorldClockDeletePresenter.h
clock/inc/Presenter/WorldClockReorderPresenter.h
clock/inc/Utils/Log.h
clock/inc/Utils/Utils.h
clock/inc/View/CounterView.h
clock/inc/View/MainView.h
clock/inc/View/WorldClockDeleteItemsView.h
clock/inc/View/WorldClockMap.h
clock/inc/View/WorldClockReorderView.h
clock/inc/View/WorldClockView.h
clock/src/View/WorldClockDeleteItemsView.cpp
clock/src/View/WorldClockReorderView.cpp
clock/src/View/WorldClockView.cpp

index bbec65f..2d71f8c 100644 (file)
@@ -97,13 +97,13 @@ namespace controller {
                        void Resume();
 
                        /**
-                        * @briefs Copies this class object instance.
+                        * @brief Copies this class object instance.
                         * @remarks Customized for singleton purpose - make no effect.
                         */
                        MainController(MainController const&) = delete;
 
                        /**
-                        * @briefs Overloads equation mark.
+                        * @brief Overloads equation mark.
                         * @remarks Customized for singleton purpose - make no effect.
                         */
                        void operator=(MainController const&) = delete;
index c2b200c..90c8b7b 100644 (file)
 #include <string>
 
 namespace model {
+       /**
+        * @brief Struct holding location information
+        */
        struct Location {
+               /** Name of location */
                std::string name;
+               /** Country of location */
                std::string country;
-
+               /** Offset of tzpath from GMT+0 (in minutes) */
                int gmt_offset_;
+               /** x coordinate on world map */
                int x;
+               /** y coordinate on world map */
                int y;
-
+               /** Summertime indicator */
                bool summertime;
+               /** Timezone name IANA compatible */
                std::string tzpath;
        };
 } /* model */
index 790f3e8..7f90349 100644 (file)
@@ -54,7 +54,7 @@ namespace model {
                        RingNewAlarmEvent(Alarm &alarm);
 
                        /**
-                        * @Gets event's alarm
+                        * @brief Gets event's alarm
                         *
                         * This method returns event's alarm.
                         *
index 2dea587..abef133 100644 (file)
@@ -35,11 +35,16 @@ namespace model {
                        std::vector<model::Location> places /**< Locations of the time zone that will be marked on the map */;
        };
 
+       /**
+        * @brief WorldClock model class
+        *
+        * Class holding all information needed to be displayed on WorldClock tab.
+        */
        class WorldClock {
                public:
 
                        /**
-                        * @brief enumeration for signals that passes parameter
+                        * @brief Enumeration for signals that passes parameter
                         *
                         * @details Only const model::Location & parameter type is allowed
                         */
@@ -48,6 +53,9 @@ namespace model {
                                MAX
                        };
 
+                       /**
+                        * @brief Model signals
+                        */
                        enum class SignalType {
                                CUSTOM_LIST_CHANGED,
                                MAX
@@ -161,7 +169,7 @@ namespace model {
                         * @brief Gets location using its no in locations_ list
                         * @remarks This function is for temporary usage and will be removed before final version
                         *
-                        * @param[no] location number
+                        * @param[in] no location number
                         *
                         * @return location
                         */
index b3d5298..45ee374 100644 (file)
 #include "Model/WorldClock.h"
 
 namespace presenter {
-
+       /**
+        * @brief WorldClock delete presenter class
+        *
+        * Class implementing business logic for WorldClockDeleteItemsView view.
+        *
+        * The logic generally refers to displaying WordlClock data model on view
+        * and updates data model depending on user interactions with view.
+        */
        class WorldClockDeletePresenter {
                public:
 
index ab70086..c35af1c 100644 (file)
 #include "Model/WorldClock.h"
 
 namespace presenter {
-
+       /**
+        * @brief WorldClock reorder presenter class
+        *
+        * Class implementing business logic for WorldClockReorderView view.
+        *
+        * The logic generally refers to displaying WordlClock data model on view
+        * and updates data model depending on user interactions with view.
+        */
        class WorldClockReorderPresenter {
                public:
                        /**
index 00649a0..d54d473 100644 (file)
        #undef LOG_TAG
 #endif
 
+/** @brief Cloc app default dlog tag */
 #define LOG_TAG "CLOCK"
 
+/** @brief macro for getting information about source file */
 #define __FILENAME__ (strrchr(__FILE__, '/') ? strrchr(__FILE__, '/') + 1 : __FILE__)
 
 #if !defined(DBG)
+/** Prints debug level information to dlog */
 #define DBG(fmt, arg...) dlog_print(DLOG_DEBUG, LOG_TAG, "%s: %s[%d]\t " #fmt "\n", __FILENAME__, __func__, __LINE__, ##arg)
 #endif
 
 #if !defined(WRN)
+/** Prints warning level information to dlog */
 #define WRN(fmt, arg...) dlog_print(DLOG_WARN, LOG_TAG, "%s: %s[%d]\t " #fmt "\n", __FILENAME__, __func__, __LINE__, ##arg)
 #endif
 
 #if !defined(ERR)
+/** Prints err level information to dlog */
 #define ERR(fmt, arg...) dlog_print(DLOG_ERROR, LOG_TAG, "%s: %s[%d]\t " #fmt "\n", __FILENAME__, __func__, __LINE__, ##arg)
 #endif
 
 #if !defined(INF)
+/** Prints info level information to dlog */
 #define INF(fmt, arg...) dlog_print(DLOG_INFO, LOG_TAG, "%s: %s[%d]\t " #fmt "\n", __FILENAME__, __func__, __LINE__, ##arg)
 #endif
 
 #if !defined(FATAL)
+/** Prints fatal level information to dlog */
 #define FAT(fmt, arg...) dlog_print(DLOG_FATAL, LOG_TAG, "%s: %s[%d]\t " #fmt "\n", __FILENAME__, __func__, __LINE__, ##arg);
 #endif
 
index 1bd898c..df4f18d 100644 (file)
 
 
 namespace utils {
+       /**
+        * @brief Resource managed for Tizen Application
+        */
        class Utils {
        public:
-               /*
+               /**
                 * @brief Application sub-directories type.
                 */
                enum AppSubdirectory {
+                       /** Data directory: ./data */
                        APP_DIR_DATA,
+                       /** Cache directory: ./cache */
                        APP_DIR_CACHE,
+                       /** Resource directory: ./res */
                        APP_DIR_RESOURCE,
+                       /** Data directory externally visible: ./shared/data */
                        APP_DIR_SHARED_DATA,
+                       /** Resource directory externally visible: ./shared/res */
                        APP_DIR_SHARED_RESOURCE,
+                       /** Resource directory externally visible for apps with same
+                        * signature: ./shared/trused */
                        APP_DIR_SHARED_TRUSTED,
+                       /** External data directory */
                        APP_DIR_EXTERNAL_DATA,
+                       /** External cache directory */
                        APP_DIR_EXTERNAL_CACHE,
+                       /** External shared data directory */
                        APP_DIR_EXTERNAL_SHARED_DATA,
                };
 
index 0ff24fe..f26b64a 100644 (file)
@@ -42,6 +42,12 @@ namespace view {
         */
        class CounterView : public ui::IView {
        public:
+               /**
+                * @brief Constructor
+                *
+                * @param[in] parent parent View
+                * @param[in] type type of counter
+                */
                CounterView(ui::IView &parent, CounterType type = CounterType::COUNTER_TYPE_STOPWATCH);
                ~CounterView();
 
index 8b199bc..1ba1e52 100644 (file)
@@ -37,6 +37,9 @@
 
 namespace view {
 
+       /**
+        * @brief Types fo views
+        */
        enum ViewType {
                ALARM,
                WORLD_CLOCK,
@@ -79,12 +82,12 @@ namespace view {
                        Evas_Object *GetConformant();
 
                        /**
-                        * @briefs Copies this class object instance.
+                        * @brief Copies this class object instance.
                         * @remarks Customized for singleton purpose - make no effect.
                         */
                        MainView(MainView const&) = delete;
                        /**
-                        * @briefs Overloads equation mark.
+                        * @brief Overloads equation mark.
                         * @remarks Customized for singleton purpose - make no effect.
                         */
                        void operator=(MainView const&) = delete;
index ed1addd..f50ab7e 100644 (file)
 
 namespace view {
        /**
-        * @brief Class representing World Clock delete subview and is responsible for UI layer of the view.
+        * @brief Class representing World Clock delete subview and is responsible
+        * for UI layer of the view.
         *
-        * @detail It allow to delete any of location list items.
+        * @details It allow to delete any of location list items.
         * It communicates with external classes by sending signals and do
         * not touch any external resources directly except utils.
         */
index 1cbb99f..8429875 100644 (file)
@@ -47,7 +47,7 @@ namespace view {
                /**
                 * @brief WorldClockMap constructor
                 *
-                * @parm[in] parent The parent of the map
+                * @param[in] parent The parent of the map
                 */
                WorldClockMap(ui::IView &parent);
                ~WorldClockMap();
index f94f795..f108f87 100644 (file)
 namespace view {
 
        /**
-        * @brief Class representing World Clock reorder subview and is responsible for UI layer of the view.
+        * @brief Class representing World Clock reorder subview and is responsible
+        * for UI layer of the view.
         *
-        * @detail It allows reorder of location list items.
+        * @details It allows reorder of location list items.
         * It communicates with external classes by sending signals and do
         * not touch any external resources directly except utils.
         */
index 8d5b8bd..1cb1efd 100644 (file)
@@ -48,7 +48,7 @@ namespace view {
        /**
         * @brief Class representing World Clock view and is responsible for UI layer of the view.
         *
-        * @detail It communicates with external classes by sending signals and do
+        * @details It communicates with external classes by sending signals and do
         * not touch any external resources directly except utils.
         */
        class WorldClockView: public ui::IView {
@@ -81,7 +81,7 @@ namespace view {
                         * @brief Registers signals
                         *
                         * @param[in] func function invoked when the signal will be emitted
-                        * @param[in] s signal enumerator
+                        * @param[in] signal signal enumerator
                         */
                        void RegisterSignal(std::function<void(void)>func, view::WorldClockSignals signal);
 
@@ -122,7 +122,7 @@ namespace view {
                        /**
                         * @brief Gets location to add.
                         *
-                        * @detail The location comes from location picker app.
+                        * @details The location comes from location picker app.
                         *
                         * @return location to add
                         */
index 7509c0b..8772144 100644 (file)
 using namespace view;
 using namespace utils;
 
+/**
+ * @brief List item data model.
+ */
 struct LocationDeleteItemData {
-
+               /** Container view */
                WorldClockDeleteItemsView *view;
+               /** elm_table object */
                Evas_Object *time;
+               /** elm_check object */
                Evas_Object *checkbox;
-
+               /** location pointer */
                const model::Location *location;
+               /** data to be displayed */
                char *date;
+               /** city to be displayed */
                char *city_country;
+               /** time offset to be displayed */
                char *gmt_offset_relative;
-
+               /** time of location timezone to GMT+0 in minutes */
                int gmt_offset;
+               /** selected status */
                bool selected;
+               /** elm_genlist item handle */
                Elm_Object_Item *it;
 };
 
index a752e0d..43484b0 100644 (file)
@@ -29,17 +29,25 @@ namespace view {
 
 using namespace utils;
 
+/**
+ * @brief List item data model
+ */
 struct LocationReorderItemData {
-
+               /** Container view handle */
                WorldClockReorderView *view;
+               /** table elm object */
                Evas_Object *time;
-
+               /** Location handle */
                const model::Location *location;
+               /** Date string */
                char *date;
+               /** City/country */
                char *city_country;
+               /** Relative offset from GMT+0 timezone */
                char *gmt_offset_relative;
-
+               /** Relative offset from GMT+0 timezone (in minutes) */
                int gmt_offset;
+               /** elm_genlist item */
                Elm_Object_Item *it;
 };
 
index d4b306e..3d75a61 100644 (file)
 using namespace view;
 using namespace utils;
 
+/**
+ * @brief Genlist item data model
+ */
 struct LocationItemData {
+               /** container view */
                WorldClockView *wc_view;
+               /** elm_time table */
                Evas_Object *time;
 
+               /** location pointer */
                const model::Location *location;
 
+               /** date to be displayed */
                char *date;
+               /** city to be displayed */
                char *city_country;
+               /** time offset to be displayed */
                char *gmt_offset_relative;
+               /** time offset from GMT+0 in minutes */
                int gmt_offset;
+               /** elm_genlist item handle */
                Elm_Object_Item *it;
 };