X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFTelSimStateManager.h;h=1b41b919a13045b1019a0d655444811342d48708;hb=refs%2Fheads%2Ftizen_2.1;hp=d2b891aaae6b2e8b2cf833b02b9594f03a613731;hpb=045bae33e8cc8a78e9798ac84671568420cfd8bc;p=platform%2Fframework%2Fnative%2Ftelephony.git

diff --git a/inc/FTelSimStateManager.h b/inc/FTelSimStateManager.h
old mode 100644
new mode 100755
index d2b891a..1b41b91
--- 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
@@ -62,20 +124,23 @@ public:
 	virtual ~SimStateManager(void);
 
 	/**
-	 * Initializes a new instance of this class.
+	 * Initializes this instance of %SimStateManager.
 	 *
 	 * @since	2.1
-	 *
+	 * @feature %http://tizen.org/feature/network.telephony
 	 * @return	An error code
 	 *
 	 * @exception	E_SUCCESS				The method is successful.
 	 * @exception	E_SYSTEM				The method cannot proceed due to a severe system error.
-   * @exception	  E_UNSUPPORTED_OPERATION	The device does not support the telephony feature.
+	 * @exception   E_UNSUPPORTED_OPERATION	 The Emulator or target device does not support the required feature.
+	 * 										 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(const Tizen::Base::String&, bool&).
 	 */
 	result Construct(void);
 
 	/**
-	 * Sets the listener for receiving SIM related events.
+	 * Sets the listener for receiving SIM-related events.
 	 *
 	 * @since   2.1
 	 *
@@ -95,8 +160,8 @@ public:
 	result SetSimEventListener(ITelephonySimEventListener* pListener);
 
 	/**
-	 * Requests the PIN lock setting information. @n
-	 * This method is asynchronous.
+	 * Requests for the PIN lock setting information. @n
+	 * The %GetPinLockSetting() method is asynchronous.
 	 *
 	 * @since   2.1
 	 *
@@ -106,7 +171,6 @@ public:
 	 * @return  An error code
 	 *
 	 * @param[in]   pListener				An ISimStateManagerGetPinLockSettingResultListener instance
-	 *
 	 * @exception   E_SUCCESS				The method is successful.
 	 * @exception	E_INVALID_ARG			The specified @c pListener must not be @c null.
 	 * @exception	E_IN_PROGRESS			The previous request is in progress.
@@ -126,7 +190,7 @@ public:
 	 * @privilege   %http://tizen.org/privilege/telephony
 	 *
 	 * @return  	The state of SIM card, @n
-	 * 				else SIM_STATE_UNKNOWN if the method fails
+	 * 				else @c SIM_STATE_UNKNOWN if the method fails
 	 *
 	 * @exception   E_SUCCESS				The method is successful.
 	 * @exception   E_PRIVILEGE_DENIED		The application does not have the privilege to call this method.
@@ -144,7 +208,6 @@ public:
 	 * @return  An error code
 	 *
 	 * @param[out]	simInfo					The SIM card information
-	 *
 	 * @exception   E_SUCCESS				The method is successful.
 	 * @exception   E_PRIVILEGE_DENIED		The application does not have the privilege to call this method.
 	 * @exception	E_DEVICE_UNAVAILABLE	The operation has failed due to a missing SIM card.