TizenRefApp-6677 Use "brief" section for extended description 61/81061/4
authorOleksander Kostenko <o.kostenko@samsung.com>
Thu, 21 Jul 2016 15:58:45 +0000 (18:58 +0300)
committerAndrey Klimenko <and.klimenko@samsung.com>
Mon, 25 Jul 2016 06:59:49 +0000 (23:59 -0700)
Change-Id: I017487aa42f3490308b13913de11cbd015e09924
Signed-off-by: Oleksander Kostenko <o.kostenko@samsung.com>
23 files changed:
src/Common/AppControl/inc/AppControlCommand.h
src/Common/AppControl/inc/AppControlCompose.h
src/Common/AppControl/inc/AppControlUtils.h
src/Common/AppControl/inc/ContactEditor.h
src/Common/AppControl/inc/ContactViewer.h
src/Common/AppControl/inc/VoiceCall.h
src/Common/Controller/inc/NaviFrameController.h
src/Common/View/inc/NaviFrameView.h
src/Common/View/inc/NoContentLayout.h
src/Common/View/inc/PopupAttachmentListItem.h
src/Common/View/inc/PopupListItem.h
src/Conversation/AppControl/inc/ContactPicker.h
src/Conversation/Recipients/View/inc/ConvRecipientsPanelView.h
src/Conversation/Utils/inc/AttachmentHandler.h
src/MsgThread/View/inc/FloatingButton.h
src/Settings/Controller/inc/MsgOnSimCard.h
src/Settings/Controller/inc/Settings.h
src/Settings/Controller/inc/SettingsListItem.h
src/Settings/Controller/inc/SettingsSound.h
src/Settings/Controller/inc/SimListViewItem.h
src/Settings/View/inc/SettingsGroupListViewItem.h
src/Settings/View/inc/SettingsListViewItem.h
src/Settings/View/inc/SimMsgLayout.h

index f87097403d3337bd0c2b4183dc43cf22a813e824..3b7f4df4ad8995855b9fecd2e0e096a5e95de947 100644 (file)
@@ -42,12 +42,12 @@ namespace Msg
             virtual ~AppControlCommand();
 
             /**
-             * Get raw operation string.
+             *@brief Get raw operation string.
              */
             const std::string &getOperationMsg() const;
 
             /**
-             * Get operation type.
+             *@brief Get operation type.
              */
             OperationType getOperationType() const;
 
index 0a7cfe11a4695eca61602693ba27836e30309f5e..5b17dd55fe3bac7f52a8c76c9c61d139df0cd8d2 100644 (file)
@@ -55,37 +55,37 @@ namespace Msg
             virtual ~AppControlCompose();
 
             /**
-             * Gets compose type.
+             *@brief Gets compose type.
              */
             OpComposeType getComposeType() const;
 
             /**
-             * Gets data from APP_CONTROL_DATA_TO or URI(if exists).
+             *@brief Gets data from APP_CONTROL_DATA_TO or URI(if exists).
              */
             const RecipientList &getRecipientList() const;
 
             /**
-             * Checks if is MMS.
+             *@brief Checks if is MMS.
              */
             bool isMms() const;
 
             /**
-             * Gets data from APP_CONTROL_DATA_TEXT.
+             *@brief Gets data from APP_CONTROL_DATA_TEXT.
              */
             const std::string &getMessageText() const;
 
             /**
-             * Gets data from APP_CONTROL_DATA_SUBJECT.
+             *@brief Gets data from APP_CONTROL_DATA_SUBJECT.
              */
             const std::string &getMessageSubject() const;
 
             /**
-             * Gets data from APP_CONTROL_DATA_PATH or URI(if exists).
+             *@brief Gets data from APP_CONTROL_DATA_PATH or URI(if exists).
              */
             const FileList &getFileList() const;
 
             /**
-             * Gets vcf info from APP_CONTROL_DATA_ID
+             *@brief Gets vcf info from APP_CONTROL_DATA_ID
              */
             const VcfInfo &getVcfInfo() const;
 
index 478071c4acebf2b22f508cbe95866e89b776e7c9..653a9340c8d217ffaf0fc4675d26a052205a052f 100644 (file)
@@ -32,27 +32,27 @@ namespace Msg
     struct AppControlUtils
     {
         /**
-         * Gets a single string from given app-control handle by a key specified
+         *@brief Gets a single string from given app-control handle by a key specified
          */
         static std::string getExtraData(app_control_h handle, const std::string &key);
 
-        /**
-        * Gets a string-array from given app-control handle by a key specified
+       /**
+        *@brief Gets a string-array from given app-control handle by a key specified
         */
         static void getExtraDataArray(app_control_h handle, const std::string &key, std::list<std::string> &outArray);
 
         /**
-         * Gets a single int number from given app-control handle by a key specified.
+         *@brief Gets a single int number from given app-control handle by a key specified.
          */
         static int getExtraDataInt(app_control_h handle, const std::string &key);
 
         /**
-         * Gets an int-array from given app-control handle by a key specified.
+         *@brief Gets an int-array from given app-control handle by a key specified.
          */
         static void getExtraDataIntArray(app_control_h handle, const std::string &key, std::list<int> &outArray);
 
         /**
-         * Gets a single mime type string from given app-control handle.
+         *@brief Gets a single mime type string from given app-control handle.
          */
         static std::string getMimeType(app_control_h handle);
     };
index 993a36e5acb13bd71d6f43f4b8eaea2d8e95058a..2b915d9ac92352d950ea527e4e950c010bb10337 100644 (file)
@@ -26,7 +26,7 @@ namespace Msg
     class IContactEditorListener;
 
     /**
-     * An utility-class aimed to launch contacts-application with add-operation and edit-operation passed via app-control.
+     *@brief An utility-class aimed to launch contacts-application with add-operation and edit-operation passed via app-control.
      */
     class ContactEditor
     {
@@ -42,14 +42,14 @@ namespace Msg
             ~ContactEditor();
 
             /**
-             * Launches add-operation.
+             * @brief Launches add-operation.
              * @param address number or email
              * @return true in case of success, otherwise returns false.
              */
              bool launch(const std::string &address, Operation operation);
 
              /**
-              * Set listener
+              * @brief Set listener
               * @param l listener
               */
              void setListener(IContactEditorListener *l);
index 4148bb0f246aa7a9aa00fae9fbb4b9ac5eb79fe9..99e07cbc896ba142a1c3200b7457817c63477c76 100644 (file)
 namespace Msg
 {
     /**
-     * An utility-class aimed to launch contacts-application with view-operation passed via app-control.
+     *@brief An utility-class aimed to launch contacts-application with view-operation passed via app-control.
      */
     class ContactViewer
     {
         public:
             /**
-             * Launches view-operation.
+             * @brief Launches view-operation.
              * @param id Contact person id or MyProfile id
              * @param ownerType PersonType or MyProfileType
              * @return true in case of success, otherwise returns false.
@@ -38,7 +38,7 @@ namespace Msg
             static bool launch(int id, ContactAddress::OwnerType ownerType);
 
             /**
-             * Launches view-operation.
+             * @brief Launches view-operation.
              * @param address reference to ContactAddress object.
              * @return true in case of success, otherwise returns false.
              */
index d4941e035f3beee4d987c41399d0a12c6496366c..b82062af97906de5ae9153d0f9301d445bd1decb 100644 (file)
@@ -24,7 +24,7 @@
 namespace Msg
 {
     /**
-     * An utility-class aimed to make voice call passed via app-control.
+     * @brief An utility-class aimed to make voice call passed via app-control.
      */
     class VoiceCall
     {
@@ -32,7 +32,7 @@ namespace Msg
         VoiceCall();
 
         /**
-         * Launches call by number
+         * @brief Launches call by number
          * @param number Contact person number
          * @return true in case of success, otherwise returns false.
          */
index 19a651dbaa0dd01706bf64d5d0be216e8154d1e8..5b20532a279b19323af1c9a6dfe5b6699fc03d62 100644 (file)
@@ -39,22 +39,22 @@ namespace Msg
             virtual ~NaviFrameController();
 
             /**
-             * Pops last frame. Exit from app if frame count reaches zero.
+             * @brief Pops last frame. Exit from app if frame count reaches zero.
              */
             void pop();
 
             /**
-             * Executes app control command of default type.
+             * @brief Executes app control command of default type.
              */
             void execCmd(const AppControlDefaultRef &cmd);
 
             /**
-             * Executes app control command of compose type. This is Compose, Share, MultiShare, ShareText.
+             * @brief Executes app control command of compose type. This is Compose, Share, MultiShare, ShareText.
              */
             void execCmd(const AppControlComposeRef &cmd);
 
             /**
-             * Destroys naviframe. Note, than this doesn't close app.
+             * @brief Destroys naviframe. Note, than this doesn't close app.
              */
             void destroy();
 
index 849ca6731beb7ad7e958e9cd0aa9f4bd7cb13a14..92aa546c7d369a1d99b8671eecf1006a2b608d99 100644 (file)
@@ -32,26 +32,26 @@ namespace Msg
             virtual ~NaviFrameView();
 
             /**
-             * Checks is it last frame.
+             * @brief Checks is it last frame.
              */
             bool isLastFrame() const;
 
             /**
-             * Get count of pushed frames.
+             * @brief Get count of pushed frames.
              */
             int getItemsCount() const;
             /**
-             * Get list of pushed frames.
+             * @brief Get list of pushed frames.
              */
             NaviFrameItemList getItems() const;
 
             /**
-             * Checks if any frame was pushed.
+             * @brief Checks if any frame was pushed.
              */
             bool isEmpty() const;
 
             /**
-             * Pushes new frame. Attaches @content to frame. Updates @item with created frame.
+             * @brief Pushes new frame. Attaches @content to frame. Updates @item with created frame.
              */
             void push(NaviFrameItem &item, Evas_Object *content = nullptr);
             void push(NaviFrameItem &item, View &content);
index f9b8585b7f596796216749901873f6d6b68a3ad7..dd61aae3d4525d0928227aafe2c133a07331935f 100644 (file)
@@ -25,7 +25,7 @@
 namespace Msg
 {
     /**
-    * A Layout that shows a message text when ThreadList is empty
+    * @brief A Layout that shows a message text when ThreadList is empty
     */
     class NoContentLayout
         : public View
index 859dc344c3f7db6f3eb4a65c383f854fb971d112..0a2059daeb4a54f8afa7f613ce45499328cff94e 100644 (file)
@@ -24,7 +24,7 @@ namespace Msg
 {
 
     /**
-     * A class of popup-for attach files
+     * @brief A class of popup-for attach files
      */
     class PopupAttachmentListItem
         : public PopupCheckListItem
index 9d09af90419d982bfcede25d66409cbb40878c55..81bdb6e27654378872d1aeaccf43f71f8a00414c 100644 (file)
@@ -31,7 +31,7 @@ namespace Msg
     }
 
     /**
-     * Generic Popup-list item class
+     * @brief Generic Popup-list item class
      */
     class PopupListItem: public ListItem
     {
@@ -46,7 +46,7 @@ namespace Msg
     };
 
     /**
-     * A class of popup-item with single text displayed
+     * @brief A class of popup-item with single text displayed
      */
     class PopupTextListItem: public PopupListItem
     {
@@ -60,7 +60,7 @@ namespace Msg
     };
 
     /**
-     * A class of popup-item with text and check field
+     * @brief A class of popup-item with text and check field
      */
     class PopupCheckListItem: public PopupListItem
     {
index eae93b9a6ff04f79783d5a613c47418e2dcea2b0..35393e1d3c501fe10890becc45b1b528130232ca 100644 (file)
@@ -25,7 +25,7 @@ namespace Msg
     class IContactPickerListener;
 
     /**
-     * An utility-class aimed to launch contacts-application with pick-operation passed via app-control.
+     * @brief An utility-class aimed to launch contacts-application with pick-operation passed via app-control.
      */
     class ContactPicker
     {
@@ -33,12 +33,12 @@ namespace Msg
         ContactPicker();
 
         /**
-         * Sets a listener-object to be notified when pick-operation succeeds.
+         * @brief Sets a listener-object to be notified when pick-operation succeeds.
          */
         void setListener(IContactPickerListener *pListener);
 
         /**
-         * Launches pick-operation.
+         * @brief Launches pick-operation.
          * @param howManyToPick defines a maximum count of contacts allowed to be picked.
          * @return true in case of success, otherwise returns false.
          */
index da2b3c056477b885da5a7a22dfc7ecfdf7ebaf2f..cc3dcc635849e9d1e312e381314e422bf04cd474 100644 (file)
@@ -47,7 +47,7 @@ namespace Msg
             void clear();
 
             /**
-             * Gets a count of mbe items
+             * @brief Gets a count of mbe items
              */
             unsigned int getItemsCount() const;
             MbeRecipientItem *getSelectedItem() const;
index e962cc572f70fbca518a7b8b227aae695570143a..86bc9598634c44d66598f196be7e86fba6c67fe2 100644 (file)
@@ -39,8 +39,8 @@ namespace Msg
             AttachmentHandler(AttachmentHandler&) = delete;
             void operator=(AttachmentHandler&) = delete;
             /**
-             * Run checking and resizing of files asynchronously.
-             * Invokes functions of IAttachmentHandlerListener.
+             * @brief Run checking and resizing of files asynchronously.
+             *        Invokes functions of IAttachmentHandlerListener.
              */
             void processFile(const std::string &file);
             void setListener(IAttachmentHandlerListener *listener);
index 02cf19e4cb80da203ac654e29b3a501dd9aaa5f5..55364272da2e44d7f83b219058606060913beb28 100644 (file)
@@ -31,7 +31,7 @@ namespace Msg
         FloatingButton(Evas_Object *parent);
 
         /**
-         * Allows to subscribe on floating button's events.
+         * @brief Allows to subscribe on floating button's events.
          * @param pListener handler of floating-button events
          */
         void setListener(IFloatingButtonListener* pListener);
index b07adaa97b197ced16a7a08a4d7fe29a1a46a4ba..a26ba0bfa2488e83148ab480f29f27009aebbe94 100644 (file)
@@ -37,7 +37,7 @@ namespace Msg
     class MsgSettings;
 
     /**
-     * Visual representation of "Messages on SIM" list.
+     * @brief Visual representation of "Messages on SIM" list.
      */
     class MsgOnSimCard
         : public FrameController
index a108dfc1c7bb749275a6b7170b8cc2ceac129716..5f771576a74ba0ce0a59ac3524279d609c313912 100644 (file)
@@ -32,8 +32,8 @@ namespace Msg
     class IMsgSettingsListener;
 
     /**
-     * A core-class responsible for a whole lifecycle of settings-module and for managing
-     * sub-components of message settings.
+     * @brief A core-class responsible for a whole lifecycle of settings-module and for managing
+     *        sub-components of message settings.
      */
     class Settings
         : public FrameController
index ddf6ef76a27afa778fc851f7daeb685709e50018..d9b83714e1d41dc9e90f60350b78c3eb00a1e248 100644 (file)
@@ -25,7 +25,7 @@ namespace Msg
     class Settings;
 
     /**
-     * Visual representation of particular element of message-settings list.
+     * @brief Visual representation of particular element of message-settings list.
      */
     class SettingsListItem
         : public SettingsListViewItem
index ea28cb4739c9e990ab0ed49e0dc643244754b765..4b9eb2508f70becfe306fe231271a8b8998ee1cb 100644 (file)
@@ -23,7 +23,7 @@ namespace Msg
     class MsgSettings;
 
     /**
-     * This class is aimed to launch preinstalled utility from settings-app that allows to chose message-alert sound.
+     * @brief This class is aimed to launch preinstalled utility from settings-app that allows to chose message-alert sound.
      */
     class SettingsSound
     {
index 85753831b413b9fb5e88b93dc33703fd681e76a5..16c4fc6064259fe9f4d9b687164383be2bd70925 100644 (file)
@@ -25,7 +25,7 @@
 namespace Msg
 {
     /**
-     * Visual representation of an element in "Messages on SIM" list.
+     * @brief Visual representation of an element in "Messages on SIM" list.
      */
     class SimListViewItem
         : public ListItem
index 85b9bf5d864ad8eb674444bffd2f639e26bf48e9..685bf96d98618c177b7edd9689b7185dd51b7c89 100644 (file)
@@ -24,7 +24,7 @@
 namespace Msg
 {
     /**
-     * Visual representation of grouping settings list items(a genlist item with "group_index" style).
+     * @brief Visual representation of grouping settings list items(a genlist item with "group_index" style).
      */
     class SettingsGroupListViewItem
         : public ListItem
index e6e3af85cba2b9d0ebb0b058e47dea56096b5f12..2514d0c05d0e914d8c685d230a7e0c91fdde5421 100644 (file)
@@ -25,7 +25,7 @@ namespace Msg
     class ISettingsListViewItemListener;
 
     /**
-     * Generic visual representation of messages-settings list element.
+     * @brief Generic visual representation of messages-settings list element.
      */
     class SettingsListViewItem
         : public ListItem
@@ -85,7 +85,7 @@ namespace Msg
             void setSubText(const std::string &text);
 
             /**
-             * Sets a listener to notify subscriber about list-item events.
+             * @brief Sets a listener to notify subscriber about list-item events.
              * @param[in] listener a listener to be notified.
              */
             void setListener(ISettingsListViewItemListener *listener);
@@ -109,7 +109,7 @@ namespace Msg
     };
 
     /**
-     * Listener to send list-item events to subscribers.
+     * @brief Listener to send list-item events to subscribers.
      */
     class ISettingsListViewItemListener
     {
index 81c5cabad9e6db7cb1b2de949b17418aab7c0c34..4c0aca682d869ef78fce9faa294ec16817ea517f 100644 (file)
@@ -24,7 +24,7 @@
 namespace Msg
 {
     /**
-     * Represents a layout of "Messages on SIM" view.
+     * @brief Represents a layout of "Messages on SIM" view.
      */
     class SimMsgLayout
         : public DefaultLayout