fixed wrong link

[platform/framework/native/appfw.git] / inc / FAppMapDataControl.h

diff --git a/inc/FAppMapDataControl.h b/inc/FAppMapDataControl.h
index a840b03..03f5c2b 100755 (executable)
--- a/inc/FAppMapDataControl.h
+++ b/inc/FAppMapDataControl.h
@@ -53,6 +53,48 @@ class IMapDataControlResponseListener;
  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/app/data_controls.htm">Data Controls</a>.
  *
  * @see        Tizen::App::AppManager
+ *
+ * @code
+ *
+ * #include <FBase.h>
+ * #include <FApp.h>
+ *
+ * using namespace Tizen::Base;
+ * using namespace Tizen::App;
+ *
+ * class MyMapDataControlResponseListener:
+ *     : public Tizen::App::IMapDataControlResponseListener
+ * {
+ * public:
+ *     void OnMapDataControlGetValueResponseReceived(RequestId reqId, const String& providerId, const String& dataId, IList& resultValueList, bool providerResult, const String* pErrorMsg)
+ *     {
+ *             int count = resultValueList.GetCount();
+ *             for (int i = 0; i < count; i++)
+ *             {
+ *                     String pPerson = static_cast< String* >(resultValueList.GetAt(i));
+ *                     AppLog("%dth person: %ls", i, pPerson->GetPointer());
+ *             }
+ *     }
+ * };
+ *
+ * void
+ * MyClass::Execute(void)
+ * {
+ *             String providerId(L"http://tizen.org/datacontrol/provider/example");
+ *             MapDataControl* pDc = AppManager::GetMapDataControlN(providerId);
+ *
+ *             MyMapDataControlResponseListener* pResponseListener = new MyMapDataControlResponseListener();
+ *
+ *             pDc->SetMapDataControlResponseListener(pResponseListener);
+ *
+ *             String dataId(L"test");
+ *             String person(L"person");
+ *             RequestId reqId;
+ *
+ *             pDc->GetValue(dataId, person, reqId);
+ * }
+ *
+ * @endcode
  */
 
 class _OSP_EXPORT_ MapDataControl
@@ -97,7 +139,7 @@ public:
        *                                                                       - The size of sending buffer has exceeded the maximum limit.
        *                                                                       - The number of sending requests has exceeded the maximum limit.
        * @exception    E_SYSTEM                        A system error has occurred.
-       * @remarks              The recommended data size is under 16KB because severe system performance degradation may occur for large messages. E_MAX_EXCEEDED may be returned for messages over 16KB size.
+       * @remarks              The recommended data size is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size.
        */
        result GetValue(const Tizen::Base::String& dataId, const Tizen::Base::String& key, RequestId& reqId, int pageNo = 1, int countPerPage = 20);
 
@@ -126,7 +168,7 @@ public:
        *                                                                       - The size of sending buffer has exceeded the maximum limit.
        *                                                                       - The number of sending requests has exceeded the maximum limit.
        * @exception    E_SYSTEM                        A system error has occurred.
-       * @remarks              The recommended data size is under 16KB because severe system performance degradation may occur for large messages. E_MAX_EXCEEDED may be returned for messages over 16KB size.
+       * @remarks              The recommended data size is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size.
        */
        result AddValue(const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& value, RequestId& reqId);
 
@@ -157,7 +199,7 @@ public:
        *                                                                       - The size of sending buffer has exceeded the maximum limit.
        *                                                                       - The number of sending requests has exceeded the maximum limit.
        * @exception    E_SYSTEM                        A system error has occurred.
-       * @remarks              The recommended data size is under 16KB because severe system performance degradation may occur for large messages. E_MAX_EXCEEDED may be returned for messages over 16KB size.
+       * @remarks              The recommended data size is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size.
        */
        result SetValue(const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& oldValue, const Tizen::Base::String& newValue, RequestId& reqId);
 
@@ -186,7 +228,7 @@ public:
        *                                                                       - The size of sending buffer has exceeded the maximum limit.
        *                                                                       - The number of sending requests has exceeded the maximum limit.
        * @exception    E_SYSTEM                        A system error has occurred.
-       * @remarks              The recommended data size is under 16KB because severe system performance degradation may occur for large messages. E_MAX_EXCEEDED may be returned for messages over 16KB size.
+       * @remarks              The recommended data size is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size.
        */
        result RemoveValue(const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& value, RequestId& reqId);