Modified doxygen sample code.
[platform/framework/native/telephony.git] / inc / FTelNetworkStatus.h
index 8bbae70..779dfb7 100755 (executable)
@@ -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
  */
@@ -95,7 +119,8 @@ public:
      *
      * @since  2.0
         *
-     * @privilege   %http://tizen.org/privilege/systeminfo
+        * @privlevel   public
+     * @privilege   %http://tizen.org/privilege/telephony
      *
      * @return @c true if the current network is in roaming status, @n
      *                  else @c false
@@ -110,7 +135,8 @@ public:
      *
      * @since  2.0
         *
-     * @privilege   %http://tizen.org/privilege/systeminfo
+        * @privlevel   public
+     * @privilege   %http://tizen.org/privilege/telephony
      *
      * @return @c true if call service is available, @n
      *          else @c false
@@ -125,7 +151,8 @@ public:
      *
      * @since  2.0
         *
-     * @privilege   %http://tizen.org/privilege/systeminfo
+        * @privlevel   public
+     * @privilege   %http://tizen.org/privilege/telephony
      *
      * @return @c true if data service is available, @n
      *          else @c false