Modified doxygen sample code.

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

diff --git a/inc/FTelNetworkManager.h b/inc/FTelNetworkManager.h
index c08a98c..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
  */
@@ -116,12 +134,14 @@ public:
      * is no listener for telephony network status change callbacks.
      *
      * @since          2.0
-        *
+        * @feature     %http://tizen.org/feature/network.telephony
      * @return         An error code
         * @param[in]   pListener       The listener for change in status of a telephony network
      * @exception      E_SUCCESS               The method is successful.
      * @exception      E_SYSTEM                A system error has occurred.
-          * @exception   E_UNSUPPORTED_OPERATION       The device does not support the telephony feature. @b Since: @b 2.1
+        * @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(ITelephonyNetworkEventListener* pListener);
 
@@ -216,7 +236,7 @@ public:
      *
      * @since 2.0
      *
-     * @privleve       platform
+     * @privlevel      platform
      * @privilege   %http://tizen.org/privilege/telephonymanager
      *
      * @return  An error code