Modified doxygen sample code.

Change-Id: I4469870072706811b427f805476c1a2981b22639
Signed-off-by: eh1112.kim <eh1112.kim@samsung.com>

diff --git a/inc/FTelCallManager.h b/inc/FTelCallManager.h
index 82b0e9f..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

diff --git a/inc/FTelNetworkInfo.h b/inc/FTelNetworkInfo.h
index 73dff11..dcb0bbb 100755 (executable)
--- a/inc/FTelNetworkInfo.h
+++ b/inc/FTelNetworkInfo.h
@@ -43,45 +43,59 @@ class _NetworkInfoImpl;
  *
  * @code
  *
- *     result
- *     MyClass::GetNetworkInfo(void)
- *     {
- *             result r = E_SUCCESS;
- *             int mnc;
- *             int mcc;
- *             int cellId;
- *             int lac;
- *             String plmn;
- *             String operatorName;
+ *  #include <FBase.h>
+ *  #include <FTelephony.h>
  *
- *             NetworkInfo networkInfo;
+ *  using namespace Tizen::Base;
+ *  using namespace Tizen::Telephony;
  *
- *             NetworkManager* pNetworkManager = new NetworkManager();
+ *  class MyClass
+ *     : public Object
+ *  {
+ *  public:
+ *     MyClass(void) {}
+ *     ~MyClass(void) {}
  *
- *             r = pNetworkManager->Construct(null);
- *             if (IsFailed(r))
- *             {
- *                     delete pNetworkManager;
- *                     return r;
- *             }
+ *     void GetNetworkInfo(void);
+ *  };
  *
- *             r = pNetworkManager->GetNetworkInfo(networkInfo);
- *             if (IsFailed(r))
- *             {
- *                     delete pNetworkManager;
- *                     return r;
- *             }
+ *  void
+ *  MyClass::GetNetworkInfo(void)
+ *  {
+ *     result r = E_SUCCESS;
+ *     int mnc;
+ *     int mcc;
+ *     int cellId;
+ *     int lac;
+ *     String plmn;
+ *     String operatorName;
  *
- *             mnc = networkInfo.GetMnc();
- *             mcc = networkInfo.GetMcc();
- *             cellId = networkInfo.GetCellId();
- *             lac = networkInfo.GetLac();
- *             plmn = networkInfo.GetPlmn();
- *             operatorName = networkInfo.GetOperatorName();
+ *     NetworkInfo networkInfo;
+ *     NetworkManager* pNetworkManager = new (std::nothrow) NetworkManager();
  *
- *             delete pNetworkManager;
- *             return r;
- *     }
+ *     r = pNetworkManager->Construct(null);
+ *     if (IsFailed(r))
+ *     {
+ *             delete pNetworkManager;
+ *             return;
+ *     }
+ *
+ *     r = pNetworkManager->GetNetworkInfo(networkInfo);
+ *     if (IsFailed(r))
+ *     {
+ *             delete pNetworkManager;
+ *             return;
+ *     }
+ *
+ *     mnc = networkInfo.GetMnc();
+ *     mcc = networkInfo.GetMcc();
+ *     cellId = networkInfo.GetCellId();
+ *     lac = networkInfo.GetLac();
+ *     plmn = networkInfo.GetPlmn();
+ *     operatorName = networkInfo.GetOperatorName();
+ *
+ *     delete pNetworkManager;
+ *  }
  *
  * @endcode
  */

diff --git a/inc/FTelNetworkManager.h b/inc/FTelNetworkManager.h
index 4e42e5d..94ff4f5 100755 (executable)
--- a/inc/FTelNetworkManager.h
+++ b/inc/FTelNetworkManager.h
@@ -48,46 +48,64 @@ class ITelephonyNetworkSettingListener;
  *
  * @code
  *
- *     result
- *     MyClass::GetNetworkManagerInfo(void)
- *     {
- *             NetworkStatus networkStatus;
- *             NetworkInfo networkInfo;
+ *  #include <FBase.h>
+ *  #include <FTelephony.h>
  *
- *             NetworkManager* pNetworkManager = new NetworkManager();
+ *   using namespace Tizen::Base;
+ *   using namespace Tizen::Telephony;
  *
- *             result r = pNetworkManager->Construct(this);
- *             if (IsFailed(r))
- *             {
- *                     delete pNetworkManager;
- *                     return r;
- *             }
+ *   class MyClass
+ *      : public Object
+ *      , public ITelephonyNetworkEventListener
+ *   {
+ *     public:
+ *      MyClass(void) {}
+ *      ~MyClass(void) {}
  *
- *             r = pNetworkManager->GetNetworkStatus(networkStatus);
- *             if (IsFailed(r))
- *             {
- *                     delete pNetworkManager;
- *                     return r;
- *             }
+ *      // ITelephonyNetworkEventListener
+ *      void OnTelephonyNetworkStatusChanged(const NetworkStatus& networkStatus);
  *
- *             r = pNetworkManager->GetNetworkInfo(networkInfo);
- *             if (IsFailed(r))
- *             {
- *                     delete pNetworkManager;
- *                     return r;
- *             }
+ *      void GetNetworkManagerInfo(void);
+ *   };
  *
- *             delete pNetworkManager;
- *             return E_SUCCESS;
- *     }
+ *   void
+ *   MyClass::OnTelephonyNetworkStatusChanged(const NetworkStatus& networkStatus)
+ *   {
+ *      bool isCallAvailable = networkStatus.IsCallServiceAvailable();
+ *      bool isDataAvailable = networkStatus.IsDataServiceAvailable();
+ *      bool isRoaming = networkStatus.IsRoaming();
+ *   }
  *
- *     void
- *     MyClass::OnTelephonyNetworkStatusChanged(const NetworkStatus& networkStatus)
- *     {
- *             bool isCallAvail = networkStatus.IsCallServiceAvailable();
- *             bool isDataAvail = networkStatus.IsDataServiceAvailable();
- *             bool isRoaming = networkStatus.IsRoaming();
- *     }
+ *   void
+ *   MyClass::GetNetworkManagerInfo(void)
+ *   {
+ *      NetworkStatus networkStatus;
+ *      NetworkInfo networkInfo;
+ *
+ *      NetworkManager* pNetworkManager = new (std::nothrow) NetworkManager();
+ *      result r = pNetworkManager->Construct(this);
+ *      if (IsFailed(r))
+ *      {
+ *              delete pNetworkManager;
+ *              return;
+ *      }
+ *
+ *      r = pNetworkManager->GetNetworkStatus(networkStatus);
+ *      if (IsFailed(r))
+ *      {
+ *              delete pNetworkManager;
+ *              return;
+ *      }
+ *
+ *      r = pNetworkManager->GetNetworkInfo(networkInfo);
+ *      if (IsFailed(r))
+ *      {
+ *              delete pNetworkManager;
+ *              return;
+ *      }
+ *
+ *      delete pNetworkManager;
+ *   }
  *
  * @endcode
  */

diff --git a/inc/FTelNetworkStatus.h b/inc/FTelNetworkStatus.h
index 895152c..779dfb7 100755 (executable)
--- a/inc/FTelNetworkStatus.h
+++ b/inc/FTelNetworkStatus.h
@@ -41,34 +41,58 @@ class _NetworkStatusImpl;
  *
  * @code
  *
- *     result
- *     MyClass::GetNetworkStatus(void)
- *     {
- *             NetworkStatus networkStatus;
- *
- *             NetworkManager* pNetworkManager = new NetworkManager();
- *
- *             result r = pNetworkManager->Construct(this);
- *             if (IsFailed(r))
- *             {
- *                     delete pNetworkManager;
- *                     return r;
- *             }
- *
- *             r = pNetworkManager->GetNetworkStatus(networkStatus);
- *             if (IsFailed(r))
- *             {
- *                     delete pNetworkManager;
- *                     return r;
- *             }
- *
- *             bool isCallAvail = networkStatus.IsCallServiceAvailable();
- *             bool isDataAvail = networkStatus.IsDataServiceAvailable();
- *             bool isRoaming = networkStatus.IsRoaming();
- *
- *             delete pNetworkManager;
- *             return E_SUCCESS;
- *     }
+ *  #include <FBase.h>
+ *  #include <FTelephony.h>
+ *
+ *   using namespace Tizen::Base;
+ *   using namespace Tizen::Telephony;
+ *
+ *   class MyClass
+ *      : public Object
+ *      , public ITelephonyNetworkEventListener
+ *   {
+ *     public:
+ *      MyClass(void) {}
+ *      ~MyClass(void) {}
+ *
+ *      // ITelephonyNetworkEventListener
+ *      void OnTelephonyNetworkStatusChanged(const NetworkStatus& networkStatus);
+ *
+ *      void GetNetworkStatus (void);
+ *   };
+ *   void
+ *   MyClass::OnTelephonyNetworkStatusChanged(const NetworkStatus& networkStatus)
+ *   {
+ *     //Do something.
+ *   }
+ *
+ *   void
+ *   MyClass::GetNetworkStatus(void)
+ *   {
+ *      NetworkStatus networkStatus;
+ *
+ *      NetworkManager* pNetworkManager = new (std::nothrow) NetworkManager();
+ *      result r = pNetworkManager->Construct(this);
+ *      if (IsFailed(r))
+ *      {
+ *              delete pNetworkManager;
+ *              return;
+ *      }
+ *
+ *      r = pNetworkManager->GetNetworkStatus(networkStatus);
+ *      if (IsFailed(r))
+ *      {
+ *              delete pNetworkManager;
+ *              return;
+ *      }
+ *
+ *      bool isCallAvailable = networkStatus.IsCallServiceAvailable();
+ *      bool isDataAvailable = networkStatus.IsDataServiceAvailable();
+ *      bool isRoaming = networkStatus.IsRoaming();
+ *
+ *      delete pNetworkManager;
+ *      return;
+ *   }
  *
  * @endcode
  */

diff --git a/inc/FTelSimInfo.h b/inc/FTelSimInfo.h
index 2302778..b85670c 100755 (executable)
--- a/inc/FTelSimInfo.h
+++ b/inc/FTelSimInfo.h
@@ -45,42 +45,58 @@ class _SimInfoImpl;
  *
  * @code
  *
- *     result
- *     MyClass::GetSimInfo(void)
- *     {
- *             int mnc;
- *             int mcc;
- *             bool isAvailable;
- *             String spn;
- *             String iccId;
- *             String operatorName;
- *             SimType simType;
+ *  #include <FBase.h>
+ *  #include <FTelephony.h>
  *
- *             SimStateManager simStateManager;
- *             SimInfo simInfo;
+ *   using namespace Tizen::Base;
+ *   using namespace Tizen::Telephony;
  *
- *             result r = simStateManager.Construct();
- *             if (IsFailed(r))
- *             {
- *                     return r;
- *             }
+ *   class MyClass
+ *      : public Object
+ *   {
+ *   public:
+ *      void GetSimInfo(void);
+ *   };
  *
- *             r = simStateManager.GetSimInfo(simInfo);
- *             if (IsFailed(r))
- *             {
- *                     return r;
- *             }
+ *   void
+ *   MyClass::GetSimInfo(void)
+ *   {
+ *      int mnc;
+ *      int mcc;
+ *      bool isAvailable;
+ *      String spn;
+ *      String iccId;
+ *      String operatorName;
+ *      SimType simType;
  *
- *             mnc = simInfo.GetMnc();
- *             mcc = simInfo.GetMcc();
- *             spn = simInfo.GetSpn();
- *             iccId = simInfo.GetIccId();
- *             operatorName = simInfo.GetOperatorName();
- *             isAvailable = simInfo.IsAvailable();
- *             simType = simInfo.GetSimType();
+ *      SimStateManager* pSimStateManager = new (std::nothrow) SimStateManager();
+ *      SimInfo simInfo;
+ *
+ *      result r = pSimStateManager->Construct();
+ *      if (IsFailed(r))
+ *      {
+ *              delete pSimStateManager;
+ *              return;
+ *      }
+ *
+ *      r = pSimStateManager->GetSimInfo(simInfo);
+ *      if (IsFailed(r))
+ *      {
+ *              delete pSimStateManager;
+ *              return;
+ *      }
+ *
+ *      mnc = simInfo.GetMnc();
+ *      mcc = simInfo.GetMcc();
+ *      spn = simInfo.GetSpn();
+ *      iccId = simInfo.GetIccId();
+ *      operatorName = simInfo.GetOperatorName();
+ *      isAvailable = simInfo.IsAvailable();
+ *      simType = simInfo.GetSimType();
+ *
+ *      delete pSimStateManager;
+ *   }
  *
- *             return E_SUCCESS;
- *     }
  *
  * @endcode
  */

diff --git a/inc/FTelSimStateManager.h b/inc/FTelSimStateManager.h
index bae966c..ec55046 100755 (executable)
--- a/inc/FTelSimStateManager.h
+++ b/inc/FTelSimStateManager.h
@@ -42,6 +42,68 @@ class _SimStateManagerImpl;
  *
  * The %SimStateManager class provides methods to obtain information and events about the SIM card.
  *
+ * @code
+ *
+ *  #include <FBase.h>
+ *  #include <FTelephony.h>
+ *
+ *  using namespace Tizen::Base;
+ *  using namespace Tizen::Telephony;
+ *
+ *  class MyClass
+ *     : public Object
+ *     , public ITelephonySimEventListener
+ *  {
+ *    public:
+ *     MyClass(void) {}
+ *     ~MyClass(void) {}
+ *
+ *   // ITelephonySimEventListener
+ *      void OnTelephonySimStateChanged(SimState state);
+ *
+ *   void GetSimState (void);
+ * };
+ *
+ *  void
+ *  MyClass::OnTelephonySimStateChanged(SimState state)
+ *  {
+ *             //Do Something.
+ *  }
+ *
+ *  void
+ *  MyClass::GetSimState(void)
+ *  {
+ *     SimStateManager* pSimStateManager = new (std::nothrow) SimStateManager();
+ *     SimInfo simInfo;
+ *     SimState simState = SIM_STATE_UNKNOWN;
+ *
+ *     result r = pSimStateManager->Construct();
+ *     if (IsFailed(r))
+ *     {
+ *             delete pSimStateManager;
+ *             return;
+ *     }
+ *
+ *     r = pSimStateManager->SetSimEventListener(this);
+ *     if (IsFailed(r))
+ *     {
+ *             delete pSimStateManager;
+ *             return;
+ *     }
+ *
+ *     r = pSimStateManager->GetSimInfo(simInfo);
+ *     if (IsFailed(r))
+ *     {
+ *             delete pSimStateManager;
+ *             return;
+ *     }
+ *
+ *     simState = pSimStateManager->GetSimState();
+ *             delete pSimStateManager;
+ *  }
+ *
+ *
+ * @endcode
  */
 class _OSP_EXPORT_ SimStateManager
        : public Tizen::Base::Object