TizenRefApp-9411 [Call UI] Add doxygen documentation for Model implementation classes 37/151937/5
authorIgor Olshevskyi <i.olshevskyi@samsung.com>
Fri, 22 Sep 2017 10:26:28 +0000 (13:26 +0300)
committerIgor Olshevskyi <i.olshevskyi@samsung.com>
Fri, 22 Sep 2017 13:33:58 +0000 (16:33 +0300)
Change-Id: I3fe628c1d0a52530623e1b9d78e5813e87d052e4

32 files changed:
call-ui/model/impl/ActiveCall.h
call-ui/model/impl/BatteryStateSource.h
call-ui/model/impl/BluetoothManager.h
call-ui/model/impl/CallClient.h
call-ui/model/impl/CallInfo.h
call-ui/model/impl/CallManager.cpp
call-ui/model/impl/CallManager.h
call-ui/model/impl/CallUI.cpp
call-ui/model/impl/CallUI.h
call-ui/model/impl/ConferenceCallInfo.h
call-ui/model/impl/ConnectionStateSource.h
call-ui/model/impl/ContactInfo.h
call-ui/model/impl/ContactInfoProvider.h
call-ui/model/impl/EndCall.h
call-ui/model/impl/HdVoiceStateSource.cpp
call-ui/model/impl/HdVoiceStateSource.h
call-ui/model/impl/HeldCall.h
call-ui/model/impl/ICallManagerListener.h
call-ui/model/impl/IIndicatorStateSource.h
call-ui/model/impl/IncomingCall.h
call-ui/model/impl/IndicatorStateProvider.h
call-ui/model/impl/MsgClient.h
call-ui/model/impl/RejectMsg.h
call-ui/model/impl/RejectMsgProvider.h
call-ui/model/impl/RssiStateSource.h
call-ui/model/impl/SimSlotStateSource.cpp
call-ui/model/impl/SimSlotStateSource.h
call-ui/model/impl/SoundManager.h
call-ui/model/impl/VoiceControlStateProvider.h
call-ui/model/impl/VoiceControlStateSource.h
call-ui/model/impl/helpers.h
call-ui/model/impl/helpers.hpp

index 834b16b19a413897f031a7073ad413a4954654fd..9b644b78f4b60aee4747c0d050943b1ddbe7de1a 100644 (file)
@@ -32,17 +32,47 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(ActiveCall);
 
+       /**
+        * @brief Represents implementation of IActiveCall interface
+        * @see IActiveCall
+        */
        class ActiveCall final : public IActiveCall {
        public:
+
+               /**
+                * @brief Creates new instance of ActiveCall
+                * @param[in] cm Weak reference to CallManager
+                * @param[in] callData The platform Call Manager Call data handle
+                * @return Shared reference to ActiveCall
+                */
                static ActiveCallSRef newInstance(CallManagerWRef cm,
                                cm_call_data_h callData);
 
                // IActiveCall //
 
+               /**
+                * @see IActiveCall::getInfo()
+                */
                virtual ICallInfoSCRef getInfo() const override final;
+
+               /**
+                * @see IActiveCall::isDialingMode()
+                */
                virtual bool isDialingMode() const override final;
+
+               /**
+                * @see IActiveCall::hold()
+                */
                virtual ucl::Result hold() override final;
+
+               /**
+                * @see IActiveCall::end()
+                */
                virtual ucl::Result end() override final;
+
+               /**
+                * @see IActiveCall::split()
+                */
                virtual ucl::Result split(
                                const IConferenceCallInfoSCRef &confCallInfo) override final;
 
index 53c5e2116416aab5a169c4401793cb3ad044e91d..9a5f06b8f69e9932113d9aa373692bfbbe72a4ce 100644 (file)
@@ -27,13 +27,31 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(BatteryStateSource);
 
+       /**
+        * @brief Represents Battery state source for IndicatorStateProvider
+        * Inherits from IIndicatorStateSource
+        * @see IIndicatorStateSource
+        */
        class BatteryStateSource final : public IIndicatorStateSource {
        public:
+
+               /**
+                * @brief Creates new instance of BatteryStateSource
+                * @return Shared reference to BatteryStateSource instance on success
+                *  or NULL otherwise
+                */
                static BatteryStateSourceSRef newInstance();
 
                // IIndicatorStateSource //
 
+               /**
+                * @see IIndicatorStateSource::getState()
+                */
                virtual IndicatorState getState() const override final;
+
+               /**
+                * @see IIndicatorStateSource::setStateChangeHandler()
+                */
                virtual void setStateChangeHandler(
                                const NotiHandler &handler) override final;
 
index 3380521deb4a3aacca920d29e87e03eed41a80ea..b1b69dcd5f5bdc8afd7d8a04c151134a732a77b0 100644 (file)
@@ -25,17 +25,55 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(BluetoothManager);
 
+       /**
+        * @brief Represents Bluetooth headset manager to operate
+        *  Headset connected devices
+        */
        class BluetoothManager final {
        public:
+
+               /**
+                * @brief Creates new instance of BluetoothManager
+                * @return Shared reference to BluetoothManager instance on success
+                *  or NULL otherwise
+                */
                static BluetoothManagerSRef newInstance();
 
+               /**
+                * @brief Gets volume level of connected BT headset device
+                * @return Volume level
+                */
                int getVolume() const;
+
+               /**
+                * @brief Gets max volume level of connected BT headset device
+                * @return Max volume level
+                */
                int getMaxVolume() const;
+
+               /**
+                * @brief Gets max volume level of connected BT headset device
+                * @param[in] volume Volume level to set
+                * @return RES_OK on success or another result otherwise
+                */
                ucl::Result setVolume(int volume);
 
+               /**
+                * @brief Sets handler for monitoring volume state change
+                * @param[in] handler Handler to set
+                */
                void setVolumeStateHandler(const NotiHandler &handler);
 
+               /**
+                * @brief Checks whether headset device is connected
+                * @return true if headset device is connected, false
+                */
                bool isHeadsetConnected() const;
+
+               /**
+                * @brief Sets handler for monitoring headset connection change
+                * @return true if headset device is connected, false
+                */
                void setHeadsetConnectionChangeHandler(const NotiHandler &handler);
 
        private:
index 3b926e25b79afe70e74df3e6afd76519f6287cfc..415753f0f3bbfcba2f3ed9c180f23e69ec87ec7a 100644 (file)
@@ -25,10 +25,29 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(CallClient);
 
+       /**
+        * @brief Represents wrapper on platform Call Manager handle
+        */
        class CallClient {
        public:
+
+               /**
+                * @brief Creates new instance of CallClient
+                * @return Shared reference to CallClient instance on success
+                *  or NULL otherwise
+                */
                static CallClientSRef newInstance();
+
+               /**
+                * @brief Gets platform Call Manager handle
+                * @return Platform Call Manager handle on success
+                *  or NULL otherwise
+                */
                cm_client_h getCmClient() const;
+
+               /**
+                * @brief Operator cm_client_h
+                */
                operator cm_client_h() const;
 
        private:
index 0042bd27d0d31c41168aa7e75ddea4fcc865c2e0..cb4029510aad3b0fb1c66e81d407ff166f3e6bd7 100644 (file)
@@ -31,23 +31,72 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(CallInfo);
 
+       /**
+        * @brief Represents implementation of ICallInfo interface
+        * @see ICallInfo
+        */
        class CallInfo final : public ICallInfo {
        public:
+
+               /**
+                * @brief Creates new instance of CallInfo
+                * @return Shared reference to CallInfo instance on success
+                *  or NULL otherwise
+                */
                static CallInfoSRef newInstance(CallClient &client,
                                cm_call_data_h callData,
                                ContactInfoProviderSRef callInfoProvider);
 
                // ICallInfo //
 
+               /**
+                * @see ICallInfo::getCallId()
+                */
                virtual unsigned int getCallId() const override final;
+
+               /**
+                * @see ICallInfo::getPhoneNumber()
+                */
                virtual const std::string &getPhoneNumber() const override final;
+
+               /**
+                * @see ICallInfo::getContactInfo()
+                */
                virtual IContactInfoSCRef getContactInfo() const override final;
+
+               /**
+                * @see ICallInfo::getDuration()
+                */
                virtual struct tm getDuration() const override final;
+
+               /**
+                * @see ICallInfo::isEmergency()
+                */
                virtual bool isEmergency() const override final;
+
+               /**
+                * @see ICallInfo::isHDVoice()
+                */
                virtual bool isHDVoice() const override final;
+
+               /**
+                * @see ICallInfo::isForwarded()
+                */
                virtual bool isForwarded() const override final;
+
+               /**
+                * @see ICallInfo::isVoiceMailNumber()
+                */
                virtual bool isVoiceMailNumber() const override final;
+
+               /**
+                * @see ICallInfo::getConferenceMemberCount()
+                */
                virtual int getConferenceMemberCount() const override final;
+
+               /**
+                * @see ICallInfo::getConferenceMemberList()
+                */
                virtual const ConfMemberList &getConferenceMemberList() const override final;
 
        private:
index f931f3e623761262932f5cf6493231204238d69e..194a6eb150c04a59e06afa74cd901f4efe8a4b7c 100644 (file)
@@ -200,7 +200,8 @@ namespace callui {
                        LOG_RETURN(RES_FAIL, "Not a member of conference call");
                }
 
-               return endCall((*iter)->getCallId(), CallReleaseType::BY_CALL_HANDLE);
+               return convertCMResult(
+                               cm_split_call(*m_callClient, (*iter)->getCallId()));
        }
 
        ContactInfoProviderSRef CallManager::getContactInfoProvider()
@@ -405,7 +406,7 @@ namespace callui {
                return dialVoiceCall(telNum);
        }
 
-       Result CallManager::processIncomingCall(SimSlot slot)
+       Result CallManager::processIncomingCall()
        {
                if (m_incomingCall) {
                        if (m_slot == SimSlot::UNDEFINED) {
index f4acbf2817fd314a2876bc0f800a0b0e4db47be9..1910ff9cca4a613c8dfdd19dc930f9318bf5370b 100644 (file)
@@ -35,31 +35,111 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(CallManager);
 
+       /**
+        * @brief Represents implementation of ICallManager interface
+        * @see ICallManager
+        */
        class CallManager final :
                public ucl::RefCountAware,
                public ICallManager {
        public:
+
+               /**
+                * @brief Creates new instance of CallManager
+                * @param[in] callClient Call client
+                * @param[in] listener Call Manager listener
+                * @return Shared reference to CallManager instance on success
+                *  or NULL otherwise
+                */
                static CallManagerSRef newInstance(const CallClientSRef &callClient,
                                ICallManagerListenerWRef listener);
 
+               /**
+                * @brief Gets call client
+                * @return Reference on CallManager instance
+                */
                CallClient &getCallClient();
+
+               /**
+                * @brief Gets active call Sim slot
+                * @return Sim slot
+                */
                SimSlot getSimSlot() const;
+
+               /**
+                * @brief Dials provided number for a voice call
+                * @param[in] number Telephone number to dial
+                * @return RES_OK on success or another result otherwise
+                */
                ucl::Result dialVoiceCall(const std::string &number);
+
+               /**
+                * @brief Ends call
+                * @param[in] callId Call ID to end
+                * @param[in] type Call release type
+                * @return RES_OK on success or another result otherwise
+                */
                ucl::Result endCall(unsigned int callId, CallReleaseType type);
+
+               /**
+                * @brief Splits selected conference call
+                * @param[in] callInfo Call info of a conference call
+                * @param[in] confCallInfo Call info of a call that must be split
+                * @return RES_OK on success or another result otherwise
+                */
                ucl::Result splitCalls(CallInfoSRef callInfo,
                                const IConferenceCallInfoSCRef &confCallInfo);
+
+               /**
+                * @brief Gets contact info provider
+                * @return Shared reference to ContactInfoProvider instance
+                */
                ContactInfoProviderSRef getContactInfoProvider();
+
+               /**
+                * @brief Gets reject message provider
+                * @return Shared reference to RejectMsgProvider instance
+                */
                RejectMsgProviderSRef getRejectMsgProvider();
 
+               /**
+                * @brief Processes outgoing call request
+                * @param[in] telNum Telephone number for outgoing call
+                * @return RES_OK on success or another result otherwise
+                */
                ucl::Result processOutgoingCall(const std::string &telNum);
-               ucl::Result processIncomingCall(SimSlot slot);
+
+               /**
+                * @brief Processes incoming call request
+                * @return RES_OK on success or another result otherwise
+                */
+               ucl::Result processIncomingCall();
 
                // ICallManager //
 
+               /*
+                * @see ICallManager::getIncomingCall()
+                */
                virtual IIncomingCallSRef getIncomingCall() override final;
+
+               /*
+                * @see ICallManager::getActiveCall()
+                */
                virtual IActiveCallSRef getActiveCall() override final;
+
+               /*
+                * @see ICallManager::getHeldCall()
+                */
                virtual IHeldCallSRef getHeldCall() override final;
+
+               /*
+                * @see ICallManager::getEndCall()
+                */
                virtual IEndCallSRef getEndCall() override final;
+
+               /*
+                * @see ICallManager::getAvailableCalls()
+                */
                virtual CallMask getAvailableCalls() const override final;
 
        private:
index b6cc9121ab6a489aa457396f42c0cab05f8f3546..17f42fb639f353036048eb15825e77f70a8f3b34 100644 (file)
@@ -89,8 +89,7 @@ namespace callui {
                        DLOG("Sim slot [%s]", tmp);
                        free(tmp);
 
-                       ret = m_callManager->processIncomingCall(
-                                       convertCMSimSlot(static_cast<cm_multi_sim_slot_type_e>(atoi(tmp))));
+                       ret = m_callManager->processIncomingCall();
 
                } else {
                        tmp = static_cast<char *>(uri + 4);
@@ -254,12 +253,12 @@ namespace callui {
 
        void CallUI::updateHdVoiceStateSource()
        {
-               m_hdCallStSrc->updateState(getHDVoiceStatus());
+               m_hdCallStSrc->setState(getHDVoiceStatus());
        }
 
        void CallUI::updateSimSlotStateSource()
        {
-               m_simSlotStSrc->updateSimSlot(m_callManager->getSimSlot(),
+               m_simSlotStSrc->setSimSlot(m_callManager->getSimSlot(),
                                getForwardedCallStatus());
        }
 
index 554f40375390c67778d35ade4acefa2b43492ed7..8114f824b0d849f8224a6427e2b171121d2e9be9 100644 (file)
@@ -37,6 +37,10 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(CallUI);
 
+       /**
+        * @brief Represents implementation of ICallUI interface
+        * @see ICallUI
+        */
        class CallUI final :
                public ucl::RefCountAware,
                public ICallUI,
@@ -45,15 +49,41 @@ namespace callui {
 
                // ICallUI //
 
+               /**
+                * @see ICallUI::setListener()
+                */
                virtual void setListener(const ICallListenerWRef &listener) override final;
+
+               /**
+                * @see ICallUI::processAppControl()
+                */
                virtual ucl::Result processAppControl(app_control_h appControl) override final;
+
+               /**
+                * @see ICallUI::getSoundManager()
+                */
                virtual ISoundManagerSRef getSoundManager() override final;
+
+               /**
+                * @see ICallUI::getCallManager()
+                */
                virtual ICallManagerSRef getCallManager() override final;
+
+               /**
+                * @see ICallUI::getIndicatorStateProvider()
+                */
                virtual IIndicatorStateProviderSRef getIndicatorStateProvider() override final;
 
                // ICallManagerListener //
 
+               /**
+                * @see ICallManagerListener::onCallEvent()
+                */
                virtual void onCallEvent(CallEventType type) override final;
+
+               /**
+                * @see ICallManagerListener::onError()
+                */
                virtual void onError(CallManagerErr err) override final;
 
        private:
index 42dbc9bdecc367b9f5010afdda49ae8f8883dde0..84e8f12cdd8e54569d9e5a92c364860bf3556072 100644 (file)
@@ -29,16 +29,39 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(ConferenceCallInfo);
 
+       /**
+        * @brief Represents implementation of IConferenceCallInfo interface
+        * @see IConferenceCallInfo
+        */
        class ConferenceCallInfo final : public IConferenceCallInfo {
        public:
+
+               /**
+                * @brief Creates new instance of ConferenceCallInfo
+                * @param[in] confCallData Native Call Manager conference call handler
+                * @param[in] callInfoProvider Contact info provider
+                * @return Shared reference to ConferenceCallInfo instance on success
+                *  or NULL otherwise
+                */
                static ConferenceCallInfoSRef newInstance(
                                cm_conf_call_data_t *confCallData,
                                ContactInfoProviderSRef callInfoProvider);
 
                // IConferenceCallInfo //
 
+               /**
+                * @see IConferenceCallInfo::getCallId()
+                */
                virtual unsigned int getCallId() const override final;
+
+               /**
+                * @see IConferenceCallInfo::getPhoneNumber()
+                */
                virtual const std::string &getPhoneNumber() const override final;
+
+               /**
+                * @see IConferenceCallInfo::getContactInfo()
+                */
                virtual IContactInfoSCRef getContactInfo() const override final;
 
        private:
index 18af9d2d03b91f3a215c36d5ec24762240b28d20..053d03fc1e6345b3274ad69fb1986ad766dfbeb8 100644 (file)
@@ -27,13 +27,30 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(ConnectionStateSource);
 
+       /**
+        * @brief Represents Connection state source for IndicatorStateProvider
+        * @see IIndicatorStateSource
+        */
        class ConnectionStateSource final : public IIndicatorStateSource {
        public:
+
+               /**
+                * @brief Creates new instance of ConnectionStateSource
+                * @return Shared reference to ConnectionStateSource instance on success
+                *  or NULL otherwise
+                */
                static ConnectionStateSourceSRef newInstance();
 
                // IIndicatorStateSource //
 
+               /**
+                * @see IIndicatorStateSource::getState()
+                */
                virtual IndicatorState getState() const override final;
+
+               /**
+                * @see IIndicatorStateSource::setStateChangeHandler()
+                */
                virtual void setStateChangeHandler(const NotiHandler &handler) override final;
 
        private:
index 3515e35ab08cd5fddb0d1ecc62d4bfc85a997aa9..064bbf5c076f32721a5e8b99728e24ee96c57722 100644 (file)
@@ -27,8 +27,22 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(ContactInfo);
 
+       /**
+        * @brief Represents implementation of IContactInfo interface
+        * @see IContactInfo
+        */
        class ContactInfo final : public IContactInfo {
        public:
+
+               /**
+                * @brief Creates new instance of ContactInfo
+                * @param[in] personId Contact database person ID
+                * @param[in] name Contact name
+                * @param[in] imagePath Path to contact image
+                * @param[in] type Contact name source type
+                * @return Shared reference to ContactInfo instance on success
+                *  or NULL otherwise
+                */
                static ContactInfoSRef newInstance(int personId,
                                const std::string &name,
                                const std::string &imagePath,
@@ -36,8 +50,19 @@ namespace callui {
 
                // IContactInfo //
 
+               /**
+                * @see IContactInfo::getName()
+                */
                virtual const std::string &getName() const override final;
+
+               /**
+                * @see IContactInfo::getImagePath()
+                */
                virtual const std::string &getImagePath() const override final;
+
+               /**
+                * @see IContactInfo::getNameSourceType()
+                */
                virtual ContactNameSourceType getNameSourceType() const override final;
 
        private:
index e248642648c75a613fcbbe8b30d5900a60ac59d8..4d3d3c92f30a933f2ab8eec54be467f63f9ec822 100644 (file)
@@ -25,10 +25,25 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(ContactInfoProvider);
 
+       /**
+        * @brief Represents Contact info provider
+        */
        class ContactInfoProvider {
        public:
+
+               /**
+                * @brief Creates new instance of ContactInfoProvider
+                * @return Shared reference to ContactInfoProvider instance on success
+                *  or NULL otherwise
+                */
                static ContactInfoProviderSRef newInstance();
 
+               /**
+                * @brief Creates new instance of ContactInfo
+                * @param[in] contactId Id of the caller in Contact database
+                * @return Shared reference to ContactInfo instance on success
+                *  or NULL otherwise
+                */
                ContactInfoSRef createContactInfo(int contactId);
 
        private:
index 1203bc79e2d7d28c0e36cfee923506711f2cef2d..925db9023be888cef1d1374b20ad70ff1132bb4f 100644 (file)
@@ -29,13 +29,32 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(EndCall);
 
+       /**
+        * @brief Implementation of IEndCall interface
+        * @see IEndCall
+        */
        class EndCall final : public IEndCall {
        public:
+
+               /**
+                * @brief Creates new instance of EndCall
+                * @param[in] cm Weak reference to CallManager
+                * @param[in] callInfo Call info of the last ended call
+                * @return Shared reference to EndCall on success
+                *  or NULL otherwise
+                */
                static EndCallSRef newInstance(CallManagerWRef cm, ICallInfoSCRef callInfo);
 
                // IEndCall //
 
+               /**
+                * @see IEndCall::getInfo()
+                */
                virtual ICallInfoSCRef getInfo() const override final;
+
+               /**
+                * @see IEndCall::callBack()
+                */
                virtual ucl::Result callBack() override final;
 
        private:
index 633210a5aa8a402ea27e29a98c0e0d8eef5ee963..a8c2019a6c395f07a6eb08a51e15152507e34a26 100644 (file)
@@ -42,7 +42,7 @@ namespace callui {
                m_bits.isEnable = isEnable;
        }
 
-       void HdVoiceStateSource::updateState(bool isEnable)
+       void HdVoiceStateSource::setState(bool isEnable)
        {
                if (m_bits.isEnable != isEnable) {
                        m_bits.isEnable = isEnable;
index deea0015086afc304757b7d4221df821d880c0cf..218b977e23353f9a1de3f168a9128b6a3f9b1dae 100644 (file)
@@ -23,14 +23,37 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(HdVoiceStateSource);
 
+       /**
+        * @brief Represents HD voice state source for IndicatorStateProvider
+        * Inherits from IIndicatorStateSource
+        * @see IIndicatorStateSource
+        */
        class HdVoiceStateSource final : public IIndicatorStateSource {
        public:
+
+               /**
+                * @brief Creates new instance of HdVoiceStateSource
+                * @return Shared reference to HdVoiceStateSource instance on success
+                *  or NULL otherwise
+                */
                static HdVoiceStateSourceSRef newInstance(bool isEnable);
-               void updateState(bool isEnable);
+
+               /**
+                * @brief Sets HD voice state
+                * @param[in] isEnable State of HD voice
+                */
+               void setState(bool isEnable);
 
                // IIndicatorStateSource //
 
+               /**
+                * @see IIndicatorStateSource::getState()
+                */
                virtual IndicatorState getState() const override final;
+
+               /**
+                * @see IIndicatorStateSource::setStateChangeHandler()
+                */
                virtual void setStateChangeHandler(const NotiHandler &handler) override final;
 
        private:
index 64d54f81cfaae0b44e70d0aa44be083d5e8d35f3..f03cb85ae656a0b054e003ef26215026b8d8d66a 100644 (file)
@@ -30,18 +30,53 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(HeldCall);
 
+       /**
+        * @brief Implementation of IHeldCall interface
+        * @see IHeldCall
+        */
        class HeldCall final : public IHeldCall {
        public:
+
+               /**
+                * @brief Creates new instance of HeldCall
+                * @param[in] cm Weak reference to CallManager
+                * @param[in] callData The platform Call Manager Call data handle
+                * @return Shared reference to HeldCall on success
+                *  or NULL otherwise
+                */
                static HeldCallSRef newInstance(CallManagerWRef cm,
                                cm_call_data_h callData);
 
                // IHeldCall //
 
+               /**
+                * @see IHeldCall::getInfo()
+                */
                virtual ICallInfoSCRef getInfo() const override final;
+
+               /**
+                * @see IHeldCall::unhold()
+                */
                virtual ucl::Result unhold() override final;
+
+               /**
+                * @see IHeldCall::joinWithActive()
+                */
                virtual ucl::Result joinWithActive() override final;
+
+               /**
+                * @see IHeldCall::swapWithActive()
+                */
                virtual ucl::Result swapWithActive() override final;
+
+               /**
+                * @see IHeldCall::end()
+                */
                virtual ucl::Result end() override final;
+
+               /**
+                * @see IHeldCall::split()
+                */
                virtual ucl::Result split(
                                const IConferenceCallInfoSCRef &confCallInfo) override final;
 
index 892e6509ff93adc7c7f08e4d96a107eaa805b105..b5ece709021785e5637927e79e47b170dcb7e7c1 100644 (file)
@@ -23,9 +23,23 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(ICallManagerListener);
 
+       /**
+        * @brief Represents Call Manager listener interface.
+        * Uses for get notifications from Call Manager about changes
+        */
        class ICallManagerListener : protected ucl::NonCopyable {
        public:
+
+               /**
+                * @brief Called on Call Manager call event
+                * @param[in] type Call event type
+                */
                virtual void onCallEvent(CallEventType type) = 0;
+
+               /**
+                * @brief Called on Call Manager error
+                * @param[in] err Error type
+                */
                virtual void onError(CallManagerErr err) = 0;
 
        protected:
index 1aa894c2a6a9e0a4aa7eba4d6f3febabc5c971a8..3869db8026f8f0ff87d2b9adf3ccc0d7f2dcb501 100644 (file)
@@ -25,9 +25,23 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(IIndicatorStateSource);
 
+       /**
+        * @brief Represents Indicator state source interface.
+        * Provides API to get value and notification about indicator state
+        */
        class IIndicatorStateSource : protected ucl::NonCopyable {
        public:
+
+               /**
+                * @brief Gets state
+                * @return Indicator state instance
+                */
                virtual IndicatorState getState() const = 0;
+
+               /**
+                * @brief Sets state change handler
+                * @param[in] handler Handler to be set
+                */
                virtual void setStateChangeHandler(const NotiHandler &handler) = 0;
 
        protected:
index 72f4e140d63a90bbe3081213b640ae2bff222ef8..839d737a0f8988c268595407cf9a7ff51f02d2fe 100644 (file)
@@ -30,17 +30,52 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(IncomingCall);
 
+       /**
+        * @brief Implementation of IIncomingCall interface
+        * @see IIncomingCall
+        */
        class IncomingCall final : public IIncomingCall {
        public:
+
+               /**
+                * @brief Creates new instance of IncomingCall
+                * @param[in] cm Weak reference to CallManager
+                * @param[in] callData The platform Call Manager Call data handle
+                * @return Shared reference to IncomingCall on success
+                *  or NULL otherwise
+                */
                static IncomingCallSRef newInstance(CallManagerWRef cm, cm_call_data_h callData);
 
                // IIncomingCall //
 
+               /*
+                * @see IIncomingCall::getInfo()
+                */
                virtual ICallInfoSCRef getInfo() const override final;
+
+               /*
+                * @see IIncomingCall::getRejectMsgProvider()
+                */
                virtual IRejectMsgProviderSRef getRejectMsgProvider() const override final;
+
+               /*
+                * @see IIncomingCall::answer()
+                */
                virtual ucl::Result answer(CallAnswerType type) override final;
+
+               /*
+                * @see IIncomingCall::reject()
+                */
                virtual ucl::Result reject() override final;
+
+               /*
+                * @see IIncomingCall::rejectWithMessage()
+                */
                virtual ucl::Result rejectWithMessage(IRejectMsgSRef message) override final;
+
+               /*
+                * @see IIncomingCall::stopAlert()
+                */
                virtual ucl::Result stopAlert() override final;
 
        private:
index 724fdf8a3812c4ec339990bd3bdc259bda30e181..30b27a78fbe51b95430d8f5813c2b2507f099049 100644 (file)
@@ -27,16 +27,39 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(IndicatorStateProvider);
 
+       /**
+        * @brief Implementation of IIndicatorStateProvider interface
+        * @see IIncomingCall
+        */
        class IndicatorStateProvider final: public IIndicatorStateProvider {
        public:
+
+               /**
+                * @brief Creates new instance of IndicatorStateProvider
+                * @return Shared reference to IndicatorStateProvider on success
+                *  or NULL otherwise
+                */
                static IndicatorStateProviderSRef newInstance();
 
+               /**
+                * @brief Sets state source
+                * @param[in] property Property type to set
+                * @param[in] source State source to set in accordance to property type
+                * @return RES_OK on success or another result otherwise
+                */
                ucl::Result setStateSource(IndicatorProperty property,
                                IIndicatorStateSourceSRef source);
 
                // IIndicatorStateProvider //
 
+               /**
+                * @see IIndicatorStateProvider::getState()
+                */
                virtual IndicatorState getState(IndicatorProperty property) const override final;
+
+               /**
+                * @see IIndicatorStateProvider::setListener()
+                */
                virtual void setListener(IIndicatorStateListenerWRef listener) override final;
 
        private:
index 96a0b039d50396007e9638d4ccccc55e1e64b12c..2ab153cc90b49d8968585f205b32dcfe7bb8336f 100644 (file)
@@ -25,10 +25,29 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(MsgClient);
 
+       /**
+        * @brief Represents wrapper on platform Message handle
+        */
        class MsgClient {
        public:
+
+               /**
+                * @brief Creates new instance of MsgClient
+                * @return Shared reference to MsgClient instance on success
+                *  or NULL otherwise
+                */
                static MsgClientSRef newInstance();
+
+               /**
+                * @brief Gets platform Message handle
+                * @return Platform Message handle on success
+                *  or NULL otherwise
+                */
                msg_handle_t getMsgHandle() const;
+
+               /**
+                * @brief Operator msg_handle_t
+                */
                operator msg_handle_t() const;
 
        private:
index b8f317f783e3c10c79ff7d452ce08ad145f96b4f..617f5b1fce0cba05b081bdd31c28f9d759b39c69 100644 (file)
@@ -29,12 +29,36 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(RejectMsg);
 
+       /**
+        * @brief Implementation of IRejectMsg interface
+        * @see IRejectMsg
+        */
        class RejectMsg : public IRejectMsg {
        public:
-               static RejectMsgSRef newInstance(MsgClientWRef client, const ucl::TString &string);
+
+               /**
+                * @brief Creates new instance of RejectMsg
+                * @param[in] client Message client instance
+                * @param[in] string Message text
+                * @return Shared reference to RejectMsg on success
+                *  or NULL otherwise
+                */
+               static RejectMsgSRef newInstance(MsgClientWRef client,
+                               const ucl::TString &string);
+
+               /**
+                * @brief Sends reject message
+                * @param[in] number Sending number
+                * @param[in] slot Sim slot to send from
+                * @return RES_OK on success or another result otherwise
+                */
                ucl::Result send(const std::string &number, SimSlot slot);
 
                // IRejectMsg //
+
+               /**
+                * @see IRejectMsg::getText()
+                */
                std::string getText() const override final;
 
        private:
index 86d663f7f3fcb3c2b5f174dd35354d75ec2e3c99..0747a421e3acc4d26332c92e2b7079f5ec4df4c4 100644 (file)
@@ -27,13 +27,30 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(RejectMsgProvider);
 
+       /**
+        * @brief Implementation of IRejectMsgProvider interface
+        * @see IRejectMsgProvider
+        */
        class RejectMsgProvider : public IRejectMsgProvider {
        public:
+
+               /**
+                * @brief Creates new instance of RejectMsgProvider
+                * @return Shared reference to RejectMsgProvider on success
+                *  or NULL otherwise
+                */
                static RejectMsgProviderSRef newInstance();
 
                // IRejectMsgProvider //
 
+               /**
+                * @see IRejectMsgProvider::getMsgList()
+                */
                virtual RejectMsgList getMsgList() const override final;
+
+               /**
+                * @see IRejectMsgProvider::getMsgCount()
+                */
                virtual int getMsgCount() const override final;
 
        private:
index c4d38124e10fc4fbe0ceba6b778bc9710ce4ce20..10761a8cd43b75cd9ad923f2c7e885425e975926 100644 (file)
@@ -27,13 +27,31 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(RssiStateSource);
 
+       /**
+        * @brief Represents RSSI state source for IndicatorStateProvider
+        * Inherits from IIndicatorStateSource
+        * @see IIndicatorStateSource
+        */
        class RssiStateSource final : public IIndicatorStateSource {
        public:
+
+               /**
+                * @brief Creates new instance of RssiStateSource
+                * @return Shared reference to RssiStateSource instance on success
+                *  or NULL otherwise
+                */
                static RssiStateSourceSRef newInstance();
 
                // IIndicatorStateSource //
 
+               /**
+                * @see IIndicatorStateSource::getState()
+                */
                virtual IndicatorState getState() const override final;
+
+               /**
+                * @see IIndicatorStateSource::setStateChangeHandler()
+                */
                virtual void setStateChangeHandler(const NotiHandler &handler) override final;
 
        private:
index 5b89186962e32698e04f4ac1f03e6a4d119b21e7..7cf7a73c49dcd4b536840bc2e482b0e5cf4d396b 100644 (file)
@@ -48,7 +48,7 @@ namespace callui {
                return makeShared<SimSlotStateSource>(slot, isForwarded);
        }
 
-       void SimSlotStateSource::updateSimSlot(SimSlot slot, bool isForwarded)
+       void SimSlotStateSource::setSimSlot(SimSlot slot, bool isForwarded)
        {
                int simSlotInt = convertEnumValueToInt(slot);
                bool needUpdate = false;
index db7f380e0137d0c750c1b375bb5ecc5a790bea12..bb3fa97d731900f6c9dc2f37a0026073885fbccc 100644 (file)
@@ -23,15 +23,41 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(SimSlotStateSource);
 
+       /**
+        * @brief Represents Sim slot source for IndicatorStateProvider
+        * Inherits from IIndicatorStateSource
+        * @see IIndicatorStateSource
+        */
        class SimSlotStateSource final : public IIndicatorStateSource {
        public:
+
+               /**
+                * @brief Creates new instance of SimSlotStateSource
+                * @param[in] slot Sim slot type
+                * @param[in] isForwarded Is current call forwarded
+                * @return Shared reference to SimSlotStateSource instance on success
+                *  or NULL otherwise
+                */
                static SimSlotStateSourceSRef newInstance(SimSlot slot,
                                bool isForwarded);
-               void updateSimSlot(SimSlot slot, bool isForwarded);
+
+               /**
+                * @brief Sets Sim slot type
+                * @param[in] slot Sim slot type
+                * @param[in] isForwarded Is current call forwarded
+                */
+               void setSimSlot(SimSlot slot, bool isForwarded);
 
                // IIndicatorStateSource //
 
+               /**
+                * @see IIndicatorStateSource::getState()
+                */
                virtual IndicatorState getState() const override final;
+
+               /**
+                * @see IIndicatorStateSource::setStateChangeHandler()
+                */
                virtual void setStateChangeHandler(
                                const NotiHandler &handler) override final;
 
index f70c4278bf1081f65e4c2aed027cfa5e440bfd6d..0f3223b83642310ec7c6cdf5f864ba88c616eafa 100644 (file)
@@ -31,49 +31,131 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(SoundManager);
 
+       /**
+        * @brief Implementation of ISoundManager interface
+        * @see ISoundManager
+        */
        class SoundManager final :
                public ucl::RefCountAware,
                public ISoundManager {
        public:
+
+               /**
+                * @brief Creates new instance of SoundManager
+                * @param[in] client Call client instance
+                * @return Shared reference to SoundManager on success
+                *  or NULL otherwise
+                */
                static SoundManagerSRef newInstance(const CallClientSRef &client);
 
                // ISoundManager //
 
+               /**
+                * @see ISoundManager::setSpeakerState()
+                */
                virtual ucl::Result setSpeakerState(bool isEnable) override final;
+
+               /**
+                * @see ISoundManager::setBluetoothState()
+                */
                virtual ucl::Result setBluetoothState(bool isEnable) override final;
+
+               /**
+                * @see ISoundManager::getAudioState()
+                */
                virtual AudioStateType getAudioState() const override final;
 
+               /**
+                * @see ISoundManager::setMuteState()
+                */
                virtual ucl::Result setMuteState(bool isEnable) override final;
+
+               /**
+                * @see ISoundManager::getMuteState()
+                */
                virtual bool getMuteState() const override final;
 
+               /**
+                * @see ISoundManager::startDtmf()
+                */
                virtual ucl::Result startDtmf(
                                const unsigned char dtmfDigit) override final;
+
+               /**
+                * @see ISoundManager::stopDtmf()
+                */
                virtual ucl::Result stopDtmf() override final;
 
+               /**
+                * @see ISoundManager::addAudioStateHandler()
+                */
                virtual void addAudioStateHandler(
                                NotiHandler handler) override final;
+
+               /**
+                * @see ISoundManager::delAudioStateHandler()
+                */
                virtual void delAudioStateHandler(
                                const NotiHandler &handler) override final;
 
+               /**
+                * @see ISoundManager::addMuteStateHandler()
+                */
                virtual void addMuteStateHandler(
                                NotiHandler handler) override final;
+
+               /**
+                * @see ISoundManager::delMuteStateHandler()
+                */
                virtual void delMuteStateHandler(
                                const NotiHandler &handler) override final;
 
+               /**
+                * @see ISoundManager::addVolumeStateHandler()
+                */
                virtual void addVolumeStateHandler(
                                NotiHandler handler) override final;
+
+               /**
+                * @see ISoundManager::delVolumeStateHandler()
+                */
                virtual void delVolumeStateHandler(
                                const NotiHandler &handler) override final;
 
+               /**
+                * @see ISoundManager::getMaxVolume()
+                */
                virtual int getMaxVolume() const override final;
+
+               /**
+                * @see ISoundManager::getVolume()
+                */
                virtual int getVolume() const override final;
+
+               /**
+                * @see ISoundManager::setVolume()
+                */
                virtual ucl::Result setVolume(int value) override final;
 
+               /**
+                * @see ISoundManager::isBTSupported()
+                */
                virtual bool isBTSupported() const override final;
 
+               /**
+                * @see ISoundManager::isBTHeadsetConnected()
+                */
                virtual bool isBTHeadsetConnected() const override final;
+
+               /**
+                * @see ISoundManager::addBTHeadsetConnectionChangeHandler()
+                */
                virtual void addBTHeadsetConnectionChangeHandler(
                                NotiHandler handler) override final;
+
+               /**
+                * @see ISoundManager::delBTHeadsetConnectionChangeHandler()
+                */
                virtual void delBTHeadsetConnectionChangeHandler(
                                const NotiHandler &handler) override final;
 
index 0c034b593376fffd7c3ef776aeaacd51d0af785e..bec63d54f80c7f7300c8b777b9aa3e2e145a3aaf 100644 (file)
@@ -25,12 +25,36 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(VoiceControlStateProvider);
 
+       /**
+        * @brief Voice control state provider.
+        * Provides state whether enable/disable voice control
+        */
        class VoiceControlStateProvider final {
        public:
+
+               /**
+                * @brief Creates new instance of VoiceControlStateProvider
+                * @return Shared reference to VoiceControlStateProvider
+                *  instance on success or NULL otherwise
+                */
                static VoiceControlStateProviderSRef newInstance();
 
+               /**
+                * Gets state
+                * @return true if aVoice control is enable, false otherwise
+                */
                bool getState() const;
+
+               /**
+                * Adds state change handler
+                * @param[in] handler Handler to add
+                */
                void addStateChangeHandler(const NotiHandler &handler);
+
+               /**
+                * Removes state change handler
+                * @param[in] handler Handler to remove
+                */
                void removeStateChangeHandler(const NotiHandler &handler);
 
        private:
index 440a904b4864d698821187c78016a5ca66054af8..85b04d611d56517dcfb88181c7eb35daf67d2e2a 100644 (file)
@@ -27,16 +27,35 @@ namespace callui {
 
        UCL_DECLARE_REF_ALIASES(VoiceControlStateSource);
 
+       /**
+        * @brief Represents Voice control state source for IndicatorStateProvider
+        * Inherits from IIndicatorStateSource
+        * @see IIndicatorStateSource
+        */
        class VoiceControlStateSource final :
                public IIndicatorStateSource,
                public ucl::RefCountAware {
        public:
+
+               /**
+                * @brief Creates new instance of VoiceControlStateSource
+                * @param[in] provider Voice control state provider
+                * @return Shared reference to VoiceControlStateSource
+                *  instance on success or NULL otherwise
+                */
                static VoiceControlStateSourceSRef newInstance(
                                const VoiceControlStateProviderSRef &provider);
 
                // IIndicatorStateSource //
 
+               /**
+                * IIndicatorStateSource::getState()
+                */
                virtual IndicatorState getState() const override final;
+
+               /**
+                * IIndicatorStateSource::setStateChangeHandler()
+                */
                virtual void setStateChangeHandler(
                                const NotiHandler &handler) override final;
 
index 7c631fbf9a95f1193cd78af1a2ff515e92f99f7d..fdf12e1b6e5143424d8459ef5183538e3ff6d790 100644 (file)
 
 namespace callui {
 
+       /**
+        * @brief Converts native Call Manager results into application results
+        * @param[in] cmRes Native Call Manager result
+        * @return Application defined result
+        */
        ucl::Result convertCMResult(int cmRes);
 
+       /**
+        * @brief Converts native Call Manager audio states types
+        *  into application types
+        * @param[in] state Native Call Manager audio states type
+        * @return Application defined audio states type
+        */
        AudioStateType convertCMAudioState(cm_audio_state_type_e state);
 
+       /**
+        * @brief Converts application Sim slot types into Call Manager types
+        * @param[in] slot Application defined sim slot type
+        * @return Native Call Manager sim slot type
+        */
        cm_multi_sim_slot_type_e convertCUISimSlot(SimSlot slot);
 
+       /**
+        * @brief Converts native Call Manager Sim slot types
+        *  into application types
+        * @param[in] slot Native Call Manager Sim slot type
+        * @return Application defined Sim slot type
+        */
        SimSlot convertCMSimSlot(cm_multi_sim_slot_type_e slot);
 
+       /**
+        * @brief Converts application call release types
+        *  into Call Manager types
+        * @param[in] type Application defined call release type
+        * @return Native Call Manager call release type
+        */
        cm_call_release_type_e convertCUICallReleaseType(CallReleaseType type);
 
-       ucl::Result convertCMEventType(cm_call_event_e cmEvent, CallEventType *appEvent);
+       /**
+        * @brief Converts native Call Manager call event types
+        *  into application types
+        * @param[in] cmEvent Native Call Manager call event type
+        * @param[out] appEvent Application defined call event type
+        * @return RES_OK on success or another result otherwise
+        */
+       ucl::Result convertCMEventType(cm_call_event_e cmEvent,
+                       CallEventType *appEvent);
 
+       /**
+        * @brief Converts application call answer types into Call Manager types
+        * @param[in] type Application defined call answer type
+        * @return Native Call Manager call answer type
+        */
        cm_call_answer_type_e convertCUICallAnswerType(CallAnswerType type);
 
+       /**
+        * @brief Checks whether Flight mode is turned on
+        * @return true if Flight mode is active, false otherwise
+        */
        bool isFlightModeActive();
 
+       /**
+        * @brief Converts enum class value to int value
+        * @param[in] e Template type of enum class
+        * @return int value of enum class
+        */
        template<typename TYPE>
-       constexpr auto convertEnumValueToInt(TYPE e) -> typename std::underlying_type<TYPE>::type
-       {
-          return static_cast<typename std::underlying_type<TYPE>::type>(e);
-       }
+       constexpr auto convertEnumValueToInt(TYPE e) ->
+                       typename std::underlying_type<TYPE>::type;
 }
 
 #include "helpers.hpp"
index 302350b9970088a0017fc460a0b2b670880cb7e6..10ae6389792aff65fe891fcaa079ac924a16d2e9 100644 (file)
@@ -132,7 +132,7 @@ namespace callui {
 
        inline bool isFlightModeActive()
        {
-               int status = false;;
+               int status = false;
                if (vconf_get_bool(VCONFKEY_TELEPHONY_FLIGHT_MODE, &status) != 0) {
                        ELOG("Get Flight mode status failed!");
                        return false;
@@ -140,4 +140,11 @@ namespace callui {
                return status;
        }
 
+       template<typename TYPE>
+       inline constexpr auto convertEnumValueToInt(TYPE e) ->
+                       typename std::underlying_type<TYPE>::type
+       {
+          return static_cast<typename std::underlying_type<TYPE>::type>(e);
+       }
+
 }