Modified doxygen sample code.

[platform/framework/native/telephony.git] / inc / FTelCallManager.h

diff --git a/inc/FTelCallManager.h b/inc/FTelCallManager.h
index 58d00cd..149baea 100755 (executable)
--- a/inc/FTelCallManager.h
+++ b/inc/FTelCallManager.h
@@ -47,46 +47,65 @@ class _CallManagerImpl;
  *
  * @code
  *
- *     result
- *     MyClass::GetCallInfo(void)
- *     {
- *             CallType callType = TYPE_UNDEFINED_CALL;
- *             CallStatus callStatus = CALL_STATUS_UNDEFINED;
+ *  #include <FBase.h>
+ *  #include <FTelephony.h>
  *
- *             CallManager* pCallManager = new CallManager();
+ *   using namespace Tizen::Base;
+ *   using namespace Tizen::Telephony;
  *
- *             result r = pCallManager->Construct(*this);
- *             if (IsFailed(r))
- *             {
- *                     delete pCallManager;
- *                     return r;
- *             }
+ *   class MyClass
+ *      : public Object
+ *      , public ITelephonyCallEventListener
+ *   {
+ *   public:
+ *      MyClass(void) {}
+ *      ~MyClass(void) {}
  *
- *             callStatus = pCallManager->GetCurrentCallStatus();
+ *      // ITelephonyCallEventListener
+ *      void OnTelephonyCallStatusChangedN(CallStatus callStatus, CallInfo* pCallInfo);
  *
- *             if (callStatus == CALL_STATUS_COMMUNICATING)
- *             {
- *                     callType = pCallManager->GetCurrentCallType();
- *             }
+ *      void GetCallInfo(void);
+ *   };
  *
- *             delete pCallManager;
- *             return E_SUCCESS;
- *     }
+ *   void
+ *   MyClass::OnTelephonyCallStatusChangedN(CallStatus callStatus, CallInfo* pCallInfo)
+ *   {
+ *      CallType callType;
+ *      String number;
  *
- *     void
- *     MyClass::OnTelephonyCallStatusChangedN(CallStatus  callStatus,CallInfo *  pCallInfo)
- *     {
- *             CallType        callType;
- *             String          number;
+ *      if (callStatus == CALL_STATUS_RINGING)
+ *      {
+ *              callType  = pCallInfo->GetCallType();
+ *              number = pCallInfo->GetNumber();
+ *      }
  *
- *             if (callStatus == CALL_STATUS_RINGING)
- *             {
- *                     callType  = pCallInfo->GetCallType();
- *                     number = pCallInfo->GetNumber();
- *             }
+ *      delete pCallInfo;
+ *   }
+ *
+ *   void
+ *   MyClass::GetCallInfo(void)
+ *   {
+ *      CallType callType = TYPE_UNDEFINED_CALL;
+ *      CallStatus callStatus = CALL_STATUS_UNDEFINED;
+ *
+ *      CallManager* pCallManager = new (std::nothrow) CallManager();
+ *
+ *      result r = pCallManager->Construct(*this);
+ *      if (IsFailed(r))
+ *      {
+ *        delete pCallManager;
+ *        return;
+ *      }
+ *
+ *      callStatus = pCallManager->GetCurrentCallStatus();
+ *      if (callStatus == CALL_STATUS_COMMUNICATING)
+ *      {
+ *              callType = pCallManager->GetCurrentCallType();
+ *      }
+ *
+ *      delete pCallManager;
+ *   }
  *
- *             delete pCallInfo;
- *     }
  *
  *
  * @endcode
@@ -114,10 +133,13 @@ public:
      * This is the two phase construction.
      *
      * @since   2.0
-        *
+        * @feature %http://tizen.org/feature/network.telephony
      * @return  An error code
      * @exception   E_SUCCESS          The method is successful.
      * @exception   E_SYSTEM           A system error has occurred.
+        * @exception  E_UNSUPPORTED_OPERATION   The Emulator or target device does not support the required feature. @b Since: @b 2.1
+        *                                                                               For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+        * @remarks     Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods.
      */
        result Construct(void);
 
@@ -126,12 +148,14 @@ public:
      * This is the two phase construction.
      *
      * @since   2.0
-        *
+        * @feature %http://tizen.org/feature/network.telephony
      * @return  An error code
      * @param[in]   listener  The listener for change in status of a call
      * @exception   E_SUCCESS The method is successful.
      * @exception   E_SYSTEM  A system error has occurred.
-     * @see ITelephonyCallEventListener
+        * @exception   E_UNSUPPORTED_OPERATION  The Emulator or target device does not support the required feature. @b Since: @b 2.1
+        *                                                                               For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+        * @remarks     Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods.
      */
        result Construct(ITelephonyCallEventListener& listener);
 
@@ -141,7 +165,7 @@ public:
      * @since   2.0
         *
      * @privlevel      platform
-     * @privilege   http://tizen.org/privilege/callforward
+     * @privilege   %http://tizen.org/privilege/callforward
      *
      * @return  An error code
      * @param[in]   pListener           An ITelephonyCallForwardListener instance @n
@@ -154,12 +178,12 @@ public:
 
        /**
      * Requests call forwarding with the specified number. @n
-     * This method sends the request to the network, and receives the response asynchronously.
+     * The %RequestCallForward() method sends the request to the network, and receives the response asynchronously.
      *
      * @since   2.0
         *
      * @privlevel      platform
-     * @privilege   http://tizen.org/privilege/callforward
+     * @privilege   %http://tizen.org/privilege/callforward
      *
      * @return  An error code
      * @param[in]   phoneNumber The phone number for call forwarding
@@ -183,7 +207,7 @@ public:
      * @since   2.0
         *
      * @privlevel      platform
-     * @privilege   http://tizen.org/privilege/callforward
+     * @privilege   %http://tizen.org/privilege/callforward
      *
      * @return  An error code
      * @exception      E_SUCCESS               The method is successful.
@@ -203,7 +227,7 @@ public:
      * @since   2.0
         *
      * @privlevel      platform
-     * @privilege   http://tizen.org/privilege/callforward
+     * @privilege   %http://tizen.org/privilege/callforward
      *
      * @return  An error code
      * @exception   E_SUCCESS               The method is successful.
@@ -222,7 +246,7 @@ public:
      * @since                  2.0
         *
      * @return      The current call type, @n
-     *              else TYPE_UNDEFINED_CALL if the method fails
+     *              else @c TYPE_UNDEFINED_CALL if the method fails
      */
        CallType GetCurrentCallType(void) const;
 
@@ -232,7 +256,7 @@ public:
      * @since                  2.0
         *
      * @return      The current call status, @n
-     *              else CALL_STATUS_UNDEFINED if the method fails
+     *              else @c CALL_STATUS_UNDEFINED if the method fails
      */
        CallStatus GetCurrentCallStatus(void) const;