TizenRefApp-9395 [Call UI] Add doxygen documentation for Model interface classes 65/151565/5
authorIgor Olshevskyi <i.olshevskyi@samsung.com>
Wed, 20 Sep 2017 14:21:50 +0000 (17:21 +0300)
committerIgor Olshevskyi <i.olshevskyi@samsung.com>
Fri, 22 Sep 2017 10:33:30 +0000 (13:33 +0300)
Change-Id: Iadc4c6d815e2aeed85490577a18b5b9861dbe7a9

21 files changed:
call-ui/model/CallUIBuilder.h
call-ui/model/IActiveCall.h
call-ui/model/IBaseCallInfo.h
call-ui/model/ICallInfo.h
call-ui/model/ICallListener.h
call-ui/model/ICallManager.h
call-ui/model/ICallUI.h
call-ui/model/IConferenceCallInfo.h
call-ui/model/IContactInfo.h
call-ui/model/IEndCall.h
call-ui/model/IHeldCall.h
call-ui/model/IIncomingCall.h
call-ui/model/IIndicatorStateListener.h
call-ui/model/IIndicatorStateProvider.h
call-ui/model/IRejectMsg.h
call-ui/model/IRejectMsgProvider.h
call-ui/model/ISoundManager.h
call-ui/model/IndicatorState.h
call-ui/model/impl/EndCall.cpp
call-ui/model/impl/EndCall.h
call-ui/model/types.h

index bf23998f95134affaa5496da6d1dd783fcb907f0..8ecfed37a91a52c019aeed83004c5b57c8c24cac 100644 (file)
@@ -25,9 +25,21 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(CallUIBuilder);
 
+       /**
+        * @brief Represents builder for CallUI
+        */
        class CallUIBuilder {
        public:
+
+               /**
+                * @brief Constructor
+                */
                CallUIBuilder();
+
+               /**
+                * @brief Builds CallUI instance
+                * @return Shared reference to ICallUI
+                */
                ICallUISRef build() const;
        };
 
index 0252b726875588992ffde9f1c65bf1bee1c1980d..301830bbca9fa94b7730dc69a348cc5b290618e8 100644 (file)
@@ -26,13 +26,44 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(IActiveCall);
 
+       /**
+        * @brief Represents Active call interface for operations with active call
+        */
        class IActiveCall : protected ucl::NonCopyable {
        public:
+
+               /**
+                * @brief Gets call info instance
+                * @return Constant shared reference to ICallInfo
+                */
                virtual ICallInfoSCRef getInfo() const = 0;
+
+
+               /**
+                * @brief Gets dialing mode state
+                * @return true if dialing mode is ON, false otherwise
+                */
                virtual bool isDialingMode() const = 0;
+
+               /**
+                * @brief Sets active call into hold state
+                * @return RES_OK on success or another result otherwise
+                */
                virtual ucl::Result hold() = 0;
+
+               /**
+                * @brief Sets active call into hold state
+                * @return RES_OK on success or another result otherwise
+                */
                virtual ucl::Result end() = 0;
-               virtual ucl::Result split(const IConferenceCallInfoSCRef &confCallInfo) = 0;
+
+               /**
+                * @brief Splits one call if call is conference
+                * @param[in] confCallInfo Call info of call that will be split
+                * @return RES_OK on success or another result otherwise
+                */
+               virtual ucl::Result split(
+                               const IConferenceCallInfoSCRef &confCallInfo) = 0;
 
        protected:
                ~IActiveCall() = default;
index 2902be3883075f46d7e128944d651f2f12980173..57b0f91e8f3102d62a99b1729570811110b7178d 100644 (file)
 
 namespace callui {
 
+       /**
+        * @brief Represents base Call info interface
+        *  for base Call info operations
+        */
        class IBaseCallInfo : protected ucl::NonCopyable {
        public:
+
+               /**
+                * @brief Gets call Id
+                * @return Call id
+                */
                virtual unsigned int getCallId() const = 0;
+
+               /**
+                * @brief Gets call phone number
+                * @return Call phone number
+                */
                virtual const std::string &getPhoneNumber() const = 0;
+
+               /**
+                * @brief Gets call contact info
+                * @return Constant shared reference to IContactInfo
+                */
                virtual IContactInfoSCRef getContactInfo() const = 0;
 
        protected:
index 33f1de4000de6fb8049aa196984d9847fdee0836..b5e2a35547e2ec3af1d7226e11c01d071a3297d5 100644 (file)
@@ -31,19 +31,64 @@ namespace callui {
 
        using ConfMemberList = std::vector<IConferenceCallInfoSCRef>;
 
+       /**
+        * @brief Represents Call info interface to get information about call
+        */
        class ICallInfo : public IBaseCallInfo {
        public:
+
+               /**
+                * @brief Gets call duration
+                * @return Call duration
+                */
                virtual struct tm getDuration() const = 0;
+
+               /**
+                * @brief Gets whether call is emergency
+                * @return true if call is emergency or false otherwise
+                */
                virtual bool isEmergency() const = 0;
+
+               /**
+                * @brief Gets whether call has HD voice
+                * @return true if call has HD voice or false otherwise
+                */
                virtual bool isHDVoice() const = 0;
+
+               /**
+                * @brief Gets whether call is forwarded
+                * @return true if call is forwarded or false otherwise
+                */
                virtual bool isForwarded() const = 0;
+
+               /**
+                * @brief Gets whether call number is voicemail
+                * @return true if call number is voicemail or false otherwise
+                */
                virtual bool isVoiceMailNumber() const = 0;
+
+               /**
+                * @brief Gets call conference members count
+                * @return Conference members count
+                */
                virtual int getConferenceMemberCount() const = 0;
+
+               /**
+                * @brief Gets call conference members list
+                * @return Conference members list
+                */
                virtual const ConfMemberList &getConferenceMemberList() const = 0;
+
+       protected:
+               ~ICallInfo() = default;
        };
 
        // Non-member functions //
 
+       /**
+        * @brief Gets whether caller telephone number is unknown
+        * @return true if call number is unknown or false otherwise
+        */
        bool isUnknownCaller(const ICallInfo &info);
 }
 
index 071fdd5e082822357cb0320bdbf2a8cfc45f47be..b67de1bb9dd8f48789bc2f72ebe20c04e1be0598 100644 (file)
@@ -23,9 +23,23 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(ICallListener);
 
+       /**
+        * @brief Represents Call listener interface for getting
+        *  notification from ICall model
+        */
        class ICallListener : protected ucl::NonCopyable {
        public:
+
+               /**
+                * @brief Called when new Call event is initiated
+                * @param[in] type Call event type
+                */
                virtual void onCallEvent(CallEventType type) = 0;
+
+               /**
+                * @brief Called when some error is happened
+                * @param[in] err Call error type
+                */
                virtual void onError(CallErr err) = 0;
 
        protected:
index 9049b0b35fd5caf2fd81d78feaca2908cfcae5e9..544ffbbb0b9c997e02d44440da4824f27f0d4950 100644 (file)
@@ -30,12 +30,45 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(ICallManager);
 
+       /**
+        * @brief Represents Call Manager interface for operations with calls
+        *  and their states
+        */
        class ICallManager : protected ucl::NonCopyable {
        public:
+
+               /**
+                * @brief Gets incoming call instance
+                * @return Shared reference to IIncomingCall instance on success
+                *  or NULL otherwise
+                */
                virtual IIncomingCallSRef getIncomingCall() = 0;
+
+               /**
+                * @brief Gets active call instance
+                * @return Shared reference to IActiveCall instance on success
+                *  or NULL otherwise
+                */
                virtual IActiveCallSRef getActiveCall() = 0;
+
+               /**
+                * @brief Gets held call instance
+                * @return Shared reference to IHeldCall instance on success
+                *  or NULL otherwise
+                */
                virtual IHeldCallSRef getHeldCall() = 0;
+
+               /**
+                * @brief Gets end call instance
+                * @return Shared reference to IEndCall instance on success
+                *  or NULL otherwise
+                */
                virtual IEndCallSRef getEndCall() = 0;
+
+               /**
+                * @brief Gets end call instance
+                * @return Mask on current available calls
+                */
                virtual CallMask getAvailableCalls() const = 0;
 
        protected:
index 41f735e674646bec70f4b48b156967e0955dd561..4b95cc10d0df2dbab2aa135c939b70aed177a27d 100644 (file)
@@ -30,12 +30,41 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(ICallUI);
 
+       /**
+        * @brief Represents CallUI interface of main model instance
+        */
        class ICallUI : protected ucl::NonCopyable {
        public:
+
+               /**
+                * @brief Sets listener
+                * @param[in] listener Call listener
+                */
                virtual void setListener(const ICallListenerWRef &listener) = 0;
+
+               /**
+                * @brief Processes app control
+                * @param[in] appControl App Control handle
+                * @return RES_OK on success or another result otherwise
+                */
                virtual ucl::Result processAppControl(app_control_h appControl) = 0;
+
+               /**
+                * @brief Gets sound manager instance
+                * @return Shared refernce to ISoundManager
+                */
                virtual ISoundManagerSRef getSoundManager() = 0;
+
+               /**
+                * @brief Gets call manager instance
+                * @return Shared refernce to ICallManager
+                */
                virtual ICallManagerSRef getCallManager() = 0;
+
+               /**
+                * @brief Gets indicator state provider instance
+                * @return Shared refernce to IIndicatorStateProvider
+                */
                virtual IIndicatorStateProviderSRef getIndicatorStateProvider() = 0;
 
        protected:
index 387dc7bba682090cc20a8975f40303dc766e0aa8..a555520296efd935d8fe8356b0ffbae9e945e060 100644 (file)
@@ -25,7 +25,14 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(IConferenceCallInfo);
 
+       /**
+        * @brief Represents conference call info interface for
+        *  getting information about callers in conference call
+        * @see IBaseCallInfo
+        */
        class IConferenceCallInfo : public IBaseCallInfo {
+       protected:
+               ~IConferenceCallInfo() = default;
        };
 }
 
index e220555458fba8076fd625c56d1df59ac7071b1e..62648364075e73cb31da9003fc8f62d186c2df42 100644 (file)
@@ -23,10 +23,29 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(IContactInfo);
 
+       /**
+        * @brief Represents Contact info interface for operations with call contact info
+        */
        class IContactInfo : protected ucl::NonCopyable {
        public:
+
+               /**
+                * @brief Gets contact name
+                * @return Contact name
+                */
                virtual const std::string &getName() const = 0;
+
+               /**
+                * @brief Gets path to contact image
+                * @return Contact image path
+                */
                virtual const std::string &getImagePath() const = 0;
+
+               /**
+                * @brief Gets name source type
+                * @remark This is source type from what contact name was took from contact database
+                * @return Contact name source type
+                */
                virtual ContactNameSourceType getNameSourceType() const = 0;
 
        protected:
index 4d8414456a3ad18e721e4337f389633d6b6a0890..b644f5cfa56e1ddb7fd1ef57d5a1c477678aca05 100644 (file)
@@ -25,11 +25,24 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(IEndCall);
 
+       /**
+        * @brief Represents End call interface for operations in end call mode
+        */
        class IEndCall : protected ucl::NonCopyable {
        public:
+
+               /**
+                * @brief Gets Call info instance
+                * @return Shared constant reference to ICallInfo instance on success
+                *  or NULL otherwise
+                */
                virtual ICallInfoSCRef getInfo() const = 0;
+
+               /**
+                * @brief Initiates recall to the last caller
+                * @return RES_OK on success or another result otherwise
+                */
                virtual ucl::Result callBack() = 0;
-               virtual ucl::Result writeMessage() = 0;
 
        protected:
                ~IEndCall() = default;
index 3fbe90d93037b277ed3a93e3bc6816ae6c8ca75a..c34c46f2fbfe30ea0bd07c581bdde0819e0d1ec0 100644 (file)
@@ -26,14 +26,53 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(IHeldCall);
 
+       /**
+        * @brief Represents Held call interface for operations with call on hold
+        */
        class IHeldCall : protected ucl::NonCopyable {
        public:
+
+               /**
+                * @brief Gets call info instance
+                * @return Shared reference to ICallInfo instance
+                *  on success or NULL otherwise
+                */
                virtual ICallInfoSCRef getInfo() const = 0;
+
+               /**
+                * @brief Unholds call
+                * @remark this API can be used if there is no other calls except this
+                * @return RES_OK on success or another result otherwise
+                */
                virtual ucl::Result unhold() = 0;
+
+               /**
+                * @brief Joins with active call
+                * @remark this API can be used if there is active call
+                * @return RES_OK on success or another result otherwise
+                */
                virtual ucl::Result joinWithActive() = 0;
+
+               /**
+                * @brief Swaps with active call
+                * @remark this API can be used if there is active call
+                * @return RES_OK on success or another result otherwise
+                */
                virtual ucl::Result swapWithActive() = 0;
+
+               /**
+                * @brief Ends call
+                * @return RES_OK on success or another result otherwise
+                */
                virtual ucl::Result end() = 0;
-               virtual ucl::Result split(const IConferenceCallInfoSCRef &confCallInfo) = 0;
+
+               /**
+                * @brief Splits one call if call is conference
+                * @param[in] confCallInfo Call info of call that will be split
+                * @return RES_OK on success or another result otherwise
+                */
+               virtual ucl::Result split(
+                               const IConferenceCallInfoSCRef &confCallInfo) = 0;
 
        protected:
                ~IHeldCall() = default;
index 48bfee5b93e453d3770919cdb36abb9c25b73f5a..5700ee3056134f59346cd8ae6bfdfc855878eae2 100644 (file)
@@ -27,13 +27,49 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(IIncomingCall);
 
+       /**
+        * @brief Represents Incoming call interface for operations with incoming call
+        */
        class IIncomingCall : protected ucl::NonCopyable {
        public:
+
+               /**
+                * @brief Gets call info instance
+                * @return Shared reference to ICallInfo instance on success
+                *  or NULL otherwise
+                */
                virtual ICallInfoSCRef getInfo() const = 0;
+
+               /**
+                * @brief Gets reject message provider instance
+                * @return Shared reference to IRejectMsgProvider instance on success
+                *  or NULL otherwise
+                */
                virtual IRejectMsgProviderSRef getRejectMsgProvider() const = 0;
+
+               /**
+                * @brief Answers call
+                * @return RES_OK on success or another result otherwise
+                */
                virtual ucl::Result answer(CallAnswerType type) = 0;
+
+               /**
+                * @brief Reject call
+                * @return RES_OK on success or another result otherwise
+                */
                virtual ucl::Result reject() = 0;
+
+               /**
+                * @brief Reject call with message
+                * @param[in] message Reject message to send
+                * @return RES_OK on success or another result otherwise
+                */
                virtual ucl::Result rejectWithMessage(IRejectMsgSRef message) = 0;
+
+               /**
+                * @brief Stops playing incoming call ringtone
+                * @return RES_OK on success or another result otherwise
+                */
                virtual ucl::Result stopAlert() = 0;
 
        protected:
index 7d42c31f3c9d1e34259e0ddd346ff0411c7fb1da..5be4c53a1ba695cf200a7a1c553f8a9b1a1311ea 100644 (file)
@@ -23,8 +23,17 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(IIndicatorStateListener);
 
+       /**
+        * @brief Represents Indicator state listener interface for
+        *  getting notification about Indicator components state changes
+        */
        class IIndicatorStateListener: protected ucl::NonCopyable {
        public:
+
+               /**
+                * @brief Called on indicator state change
+                * @param[in] property Indicator property that is changed
+                */
                virtual void onStateChanged(IndicatorProperty property) = 0;
 
        protected:
index c2271e6d938e363080514ed799e315183ea5a181..e5349246171f60f0dd7fc34e5fb31bf3e88ca501 100644 (file)
@@ -26,9 +26,24 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(IIndicatorStateProvider);
 
+       /**
+        * @brief Represents Indicator state provider
+        *  interface for operations with indicator states
+        */
        class IIndicatorStateProvider : protected ucl::NonCopyable {
        public:
+
+               /**
+                * @brief Gets indicator state by property type
+                * @param[in] property Indicator property type
+                * @return Indicator state instance
+                */
                virtual IndicatorState getState(IndicatorProperty property) const = 0;
+
+               /**
+                * @brief Sets listener
+                * @param[in] listener Indicator state listener
+                */
                virtual void setListener(IIndicatorStateListenerWRef listener) = 0;
 
        protected:
index a8b8ec7d87229d9965d78e91a7641ab588806ad9..893cc1e035cd7896699da008341206189167941a 100644 (file)
@@ -23,8 +23,17 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(IRejectMsg);
 
+       /**
+        * @brief Represents Reject message interface
+        *  for operations with reject message
+        */
        class IRejectMsg : protected ucl::NonCopyable {
        public:
+
+               /**
+                * @brief Gets reject message text
+                * @return Reject message text
+                */
                virtual std::string getText() const = 0;
 
        protected:
index 20b395cd6fcef8f3f66906fd013c89ea64f4584c..8e35a62dd2a4ff1a9aedd731720d6ac71562e629 100644 (file)
@@ -25,12 +25,28 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(IRejectMsgProvider);
 
+       /**
+        * @brief Represents Reject message provider interface for
+        *  getting reject messages
+        */
        class IRejectMsgProvider : protected ucl::NonCopyable {
        public:
+               /**
+                * @brief List of reject messages
+                */
                using RejectMsgList = std::vector<IRejectMsgSRef>;
 
        public:
+               /**
+                * @brief Gets reject message list
+                * @return Reject message list
+                */
                virtual RejectMsgList getMsgList() const = 0;
+
+               /**
+                * @brief Gets reject message count
+                * @return Reject message count
+                */
                virtual int getMsgCount() const = 0;
 
        protected:
index fb728963445b77c6d0432d8477c188640cf78ea2..4012cf9306e9d41448cd79eebd3fc9d48fbc55c2 100644 (file)
@@ -23,34 +23,137 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(ISoundManager);
 
+       /**
+        * @brief Represents Sound manager interface for operations
+        *  with sound during call
+        */
        class ISoundManager: protected ucl::NonCopyable {
        public:
+
+               /**
+                * @brief Sets speaker state
+                * @param[in] isEnable Speaker state to set
+                * @return RES_OK on success or another result otherwise
+                */
                virtual ucl::Result setSpeakerState(bool isEnable) = 0;
+
+               /**
+                * @brief Sets Bluetooth headset connection state
+                * @param[in] isEnable Bluetooth headset connection state to set
+                * @return RES_OK on success or another result otherwise
+                */
                virtual ucl::Result setBluetoothState(bool isEnable) = 0;
+
+               /**
+                * @brief Gets current audio state
+                * @return Audio state type
+                */
                virtual AudioStateType getAudioState() const = 0;
+
+               /**
+                * @brief Sets mute state
+                * @param[in] isEnable Mute state to set
+                * @return RES_OK on success or another result otherwise
+                */
                virtual ucl::Result setMuteState(bool isEnable) = 0;
+
+               /**
+                * @brief Gets mute state
+                * @return Mute state
+                */
                virtual bool getMuteState() const = 0;
+
+               /**
+                * @brief Starts DTMF signal
+                * @param[in] dtmfDigit DTMF digit to start
+                * @return RES_OK on success or another result otherwise
+                */
                virtual ucl::Result startDtmf(const unsigned char dtmfDigit) = 0;
+
+               /**
+                * @brief Stops DTMF signal
+                * @return RES_OK on success or another result otherwise
+                */
                virtual ucl::Result stopDtmf() = 0;
-               virtual void addAudioStateHandler(
-                               NotiHandler handler) = 0;
-               virtual void delAudioStateHandler(
-                               const NotiHandler &handler) = 0;
-               virtual void addMuteStateHandler(
-                               NotiHandler handler) = 0;
-               virtual void delMuteStateHandler(
-                               const NotiHandler &handler) = 0;
-               virtual void addVolumeStateHandler(
-                               NotiHandler handler) = 0;
-               virtual void delVolumeStateHandler(
-                               const NotiHandler &handler) = 0;
+
+               /**
+                * @brief Adds audio state handler
+                * @param[in] handler Handler to add
+                */
+               virtual void addAudioStateHandler(NotiHandler handler) = 0;
+
+               /**
+                * @brief Deletes audio state handler
+                * @param[in] handler Handler to delete
+                */
+               virtual void delAudioStateHandler(const NotiHandler &handler) = 0;
+
+               /**
+                * @brief Adds mute state handler
+                * @param[in] handler Handler to add
+                */
+               virtual void addMuteStateHandler(NotiHandler handler) = 0;
+
+               /**
+                * @brief Deletes mute state handler
+                * @param[in] handler Handler to delete
+                */
+               virtual void delMuteStateHandler(const NotiHandler &handler) = 0;
+
+               /**
+                * @brief Adds volume state handler
+                * @param[in] handler Handler to add
+                */
+               virtual void addVolumeStateHandler(NotiHandler handler) = 0;
+
+               /**
+                * @brief Deletes volume state handler
+                * @param[in] handler Handler to delete
+                */
+               virtual void delVolumeStateHandler(const NotiHandler &handler) = 0;
+
+               /**
+                * @brief Gets max volume level
+                * @return Max volume level value
+                */
                virtual int getMaxVolume() const = 0;
+
+               /**
+                * @brief Gets current volume level
+                * @return Current volume level value
+                */
                virtual int getVolume() const = 0;
+
+               /**
+                * @brief Sets volume level
+                * @param[in]   value   Volume level value to set
+                * @return RES_OK on success or another result otherwise
+                */
                virtual ucl::Result setVolume(int value) = 0;
+
+               /**
+                * @brief Checks whether Bluetooth is supported
+                * @return true is supported, false otherwise
+                */
                virtual bool isBTSupported() const = 0;
+
+               /**
+                * @brief Checks whether Bluetooth Headset is connected
+                * @return true if connected, false otherwise
+                */
                virtual bool isBTHeadsetConnected() const = 0;
+
+               /**
+                * @brief Adds Bluetooth Headset connection change handler
+                * @param[in] handler Handler to add
+                */
                virtual void addBTHeadsetConnectionChangeHandler(
                                NotiHandler handler) = 0;
+
+               /**
+                * @brief Deletes Bluetooth Headset connection change handler
+                * @param[in] handler Handler to delete
+                */
                virtual void delBTHeadsetConnectionChangeHandler(
                                const NotiHandler &handler) = 0;
 
index 1fa6a0509ac7fbdbdde8d5bc7e6c8d3b1416eba9..36f7424a4190f334397ba6f52beb548c07751923 100644 (file)
 
 namespace callui {
 
+       /**
+        * @brief Represents Indicator state instance
+        */
        struct IndicatorState {
                uint64_t value;
        };
 
+       /**
+        * @brief Gets connection state
+        * @param[in] state Indicator state
+        * @return Connection type
+        */
        ConnectionType getConnectionState(IndicatorState state);
+
+       /**
+        * @brief Gets packet direction
+        * @param[in] state Indicator state
+        * @return Packet direction type
+        */
        PacketDirection getPacketDirection(IndicatorState state);
+
+       /**
+        * @brief Gets RSSI state
+        * @param[in] state Indicator state
+        * @return RSSI state
+        */
        RssiState getRssiState(IndicatorState state);
+
+       /**
+        * @brief Gets roaming state
+        * @param[in] state Indicator state
+        * @return true if roaming is on, false otherwise
+        */
        bool getRoamingState(IndicatorState state);
+
+       /**
+        * @brief Gets battery charge level
+        * @param[in] state Indicator state
+        * @return Battery charge level
+        */
        int getBatteryLevel(IndicatorState state);
+
+       /**
+        * @brief Gets battery state
+        * @param[in] state Indicator state
+        * @return Battery state
+        */
        BatteryState getBatteryState(IndicatorState state);
+
+       /**
+        * @brief Gets voice control state
+        * @param[in] state Indicator state
+         * @return true if voice control is on, false otherwise
+        */
        bool getVoiceControlState(IndicatorState state);
+
+       /**
+        * @brief Gets current active sim slot type
+        * @param[in] state Indicator state
+         * @return Sim slot type
+        */
        SimSlot getSimSlotType(IndicatorState state);
+
+       /**
+        * @brief Gets whether sim must have forwarded state
+        * @param[in] state Indicator state
+        * @return true if sim call forwarded state is set, false otherwise
+        */
        bool getSimForwardState(IndicatorState state);
+
+       /**
+        * @brief Gets whether current call has HD voice
+        * @param[in] state Indicator state
+        * @return true if current call has HD voice, false otherwise
+        */
        bool getHDVoiceState(IndicatorState state);
 
 }
index f9e34e31eead28b6561f99d3626b6613cb10c62a..bc8ca965059f2946a6143d0525bddbb0e659904d 100644 (file)
@@ -66,9 +66,4 @@ namespace callui {
                return res;
        }
 
-       Result EndCall::writeMessage()
-       {
-               UCL_ASSERT(0, "!!! NOT IMPLEMENTED !!!");
-       }
-
 }
index 681256623d43d272da033cc44220f8fcf261b4ef..1203bc79e2d7d28c0e36cfee923506711f2cef2d 100644 (file)
@@ -37,7 +37,6 @@ namespace callui {
 
                virtual ICallInfoSCRef getInfo() const override final;
                virtual ucl::Result callBack() override final;
-               virtual ucl::Result writeMessage() override final;
 
        private:
                EndCall(CallManagerWRef cm, ICallInfoSCRef callInfo);
index f91a0ad53c93d0c514297735446345ed305a22f1..7d82b2c6e63d3bcb3721493a02ff06821fd75b6c 100644 (file)
 
 namespace callui {
 
+       /**
+        * @brief Enumeration for call error type
+        */
        enum class CallErr {
-               DIAL_CANCEL,
-               DIAL_FAIL,
-               DIAL_FLIGHT_MODE
+               DIAL_CANCEL,              /**< Dial canceled by system service */
+               DIAL_FAIL,                /**< Dial on provided number failed */
+               DIAL_FLIGHT_MODE          /**< Flight mode is on */
        };
 
+       /**
+        * @brief Enumeration for sim slot type
+        */
        enum class SimSlot {
-               UNDEFINED = 0,
-               GEAR,
-               MOBILE_FIRST,
-               MOBILE_SECOND,
-               MOBILE_DEFAULT
+               UNDEFINED = 0,             /**< Undefined Sim slot */
+               GEAR,                      /**< Gear Sim card */
+               MOBILE_FIRST,              /**< Mobile first Sim card */
+               MOBILE_SECOND,             /**< Mobile second Sim card */
+               MOBILE_DEFAULT             /**< Mobile default Sim card */
        };
 
+       /**
+        * Enumeration for call answer type
+        */
        enum class CallAnswerType {
-               NORMAL,
-               HOLD_ACTIVE_AND_ACCEPT,
-               RELEASE_ACTIVE_AND_ACCEPT,
-               RELEASE_HOLD_AND_ACCEPT,
-               RELEASE_ALL_AND_ACCEPT
+               NORMAL,                    /**< Only single call exist, Accept the Incoming call */
+               HOLD_ACTIVE_AND_ACCEPT,    /**< Put the active call on hold and accepts the call */
+               RELEASE_ACTIVE_AND_ACCEPT, /**< Releases the active call and accept the call */
+               RELEASE_HOLD_AND_ACCEPT,   /**< Releases the held call and accept the call */
+               RELEASE_ALL_AND_ACCEPT     /**< Releases all calls and accept the call */
        };
 
+       /**
+        * @brief Enumeration for audio state type
+        */
        enum class AudioStateType {
-               NONE,
-               SPEAKER,
-               RECEIVER,
-               EARJACK,
-               BT
+               NONE,                      /**< None */
+               SPEAKER,                   /**< System LoudSpeaker path */
+               RECEIVER,                  /**< System Receiver */
+               EARJACK,                   /**< Earjack path */
+               BT                         /**< System BT Headset path */
        };
 
+       /**
+        * @brief Enumeration for call flags of current available calls
+        */
        enum {
-               CALL_FLAG_NONE     = 0,
-               CALL_FLAG_INCOMING = 1,
-               CALL_FLAG_ACTIVE   = 2,
-               CALL_FLAG_HELD     = 4,
-               CALL_FLAG_END      = 8
+               CALL_FLAG_NONE     = 0,    /**< None */
+               CALL_FLAG_INCOMING = 1,    /**< Incoming call flag value */
+               CALL_FLAG_ACTIVE   = 2,    /**< Active call flag value */
+               CALL_FLAG_HELD     = 4,    /**< Held call flag value */
+               CALL_FLAG_END      = 8     /**< End call flag value */
        };
+       /**
+        * @brief CallMask definition
+        */
        using CallMask = int;
 
+       /**
+        * Enumeration for Call event type
+        */
        enum class CallEventType {
-               END,
-               DIALING,
-               ACTIVE,
-               HELD,
-               ALERT,
-               INCOMING,
-               WAITING,
-               JOIN,
-               SPLIT,
-               SWAPPED,
-               RETRIEVED,
-               SAT_CALL_CONTROL
+               END,                       /**< Call End event */
+               DIALING,                   /**< Call Dialing event */
+               ACTIVE,                    /**< Call Active event */
+               HELD,                      /**< Call Held event */
+               ALERT,                     /**< Call Alert event */
+               INCOMING,                  /**< Call Incoming event */
+               WAITING,                   /**< Call Waiting event */
+               JOIN,                      /**< Call Join event */
+               SPLIT,                     /**< Call Split event */
+               SWAPPED,                   /**< Call Swapped event */
+               RETRIEVED,                 /**< Call Retrieved event */
+               SAT_CALL_CONTROL           /**< Sat call control event */
        };
 
+
+       /**
+        * @brief Enumeration for Contact display name source type
+        */
        enum class ContactNameSourceType {
-               INVALID,
-               EMAIL,
-               NUMBER,
-               NICKNAME,
-               COMPANY,
-               NAME
+               INVALID,                   /**< Invalid source of display name */
+               EMAIL,                     /**< Produced display name from email record */
+               NUMBER,                    /**< Produced display name from number record */
+               NICKNAME,                  /**< Produced display name from nickname record */
+               COMPANY,                   /**< Produced display name from company record */
+               NAME                       /**< Produced display name from name record */
        };
 
+       /**
+        * @brief Enumeration for Network connection type
+        */
        enum class ConnectionType {
-               NONE = 0,
-               EDGE_E,
-               GPRS_G,
-               SIMPLE_2G,
-               HSDPA_H,
-               HSPA_H_PLUS,
-               LTE_4G,
-               UMTS_3G,
-               UMTS_3G_PLUS,
-               NO_SIM,
-               WIFI_00,
-               WIFI_01,
-               WIFI_02,
-               WIFI_03,
-               WIFI_04,
-               NO_SIGNAL
+               NONE = 0,                  /**< None */
+               EDGE_E,                    /**< EDGE */
+               GPRS_G,                    /**< GPRS */
+               SIMPLE_2G,                 /**< 2G */
+               HSDPA_H,                   /**< HSDPA */
+               HSPA_H_PLUS,               /**< HSPA Plus */
+               LTE_4G,                    /**< LTE 4G */
+               UMTS_3G,                   /**< UMTS 3G */
+               UMTS_3G_PLUS,              /**< UMTS 3G Plus */
+               NO_SIM,                    /**< No SIM */
+               WIFI_00,                   /**< WiFi strength level 0 */
+               WIFI_01,                   /**< WiFi strength level 1 */
+               WIFI_02,                   /**< WiFi strength level 2 */
+               WIFI_03,                   /**< WiFi strength level 3 */
+               WIFI_04,                   /**< WiFi strength level 4 */
+               NO_SIGNAL,                 /**< No signal */
        };
 
+       /**
+        * @brief Enumeration for Packet direction type
+        */
        enum class PacketDirection {
-               NONE = 0,
-               NO_INPUT,
-               IN,
-               OUT,
-               INOUT
+               NONE = 0,                  /**< None */
+               NO_INPUT,                  /**< No input */
+               IN,                        /**< Incoming */
+               OUT,                       /**< Outgoing */
+               INOUT                      /**< Incoming and outgoing */
        };
 
+       /**
+        * @brief Enumeration for RSSI state
+        */
        enum class RssiState {
-               NONE = 0,
-               LEVEL_0,
-               LEVEL_1,
-               LEVEL_2,
-               LEVEL_3,
-               LEVEL_4,
-               NO_SIGNAL,
-               FLIGHT_MODE
+               NONE = 0,                  /**< None */
+               LEVEL_0,                   /**< Level 0 */
+               LEVEL_1,                   /**< Level 1 */
+               LEVEL_2,                   /**< Level 2 */
+               LEVEL_3,                   /**< Level 3 */
+               LEVEL_4,                   /**< Level 4 */
+               NO_SIGNAL,                 /**< No signal */
+               FLIGHT_MODE                /**< Flight mode */
        };
 
+       /**
+        * @brief Enumeration for Battery state
+        */
        enum class BatteryState {
-               NORMAL = 0,
-               CHARGING,
-               CHARGING_PROBLEM,
-               UNKNOWN
+               NORMAL = 0,                /**< Normal battery work flaw */
+               CHARGING,                  /**< Battery is charging */
+               CHARGING_PROBLEM,          /**< Battery charging issue */
+               UNKNOWN                    /**< Unknown battery state */
        };
 
+       /**
+        * @brief Enumeration for Indicator property type
+        */
        enum class IndicatorProperty {
-               NW_CONNECTION = 0,
-               RSSI,
-               BATTERY,
-               VOICE_CONTROL,
-               SIM_SLOT,
-               HD_VOICE
+               NW_CONNECTION = 0,         /**< Network connection property */
+               RSSI,                      /**< RSSI property */
+               BATTERY,                   /**< Battery property */
+               VOICE_CONTROL,             /**< Voice control property */
+               SIM_SLOT,                  /**< Sim slot property */
+               HD_VOICE                   /**< Call HD voice property */
        };
 
 }