doc/mainpage.dox

   1 /**\r
   2  @mainpage Sync-agent Framework\r
   3 \r
   4  @section Introduction\r
   5 The purposes of this guide are to describe the Tizen Sync-agent Framework<br>\r
   6 and to explain how to use the Sync-agent Framework APIs to develop Tizen sync client applications<br>\r
   7 that can be implemented in Samsung mobile devices.<br>\r
   8 \r
   9 This guide does not discuss building and deploying Tizen applications.<br>\r
  10 The content presentation is based on the assumption that you are knowledgeable in the Tizen programming environment.<br>\r
  11 \r
  12  @section Overview\r
  13 \r
  14 @image html overview_sync_agent_framework.png "Software architecture of Sync-agent Framework"\r
  15 \r
  16 Sync-agent Framework provides common elementaries necessary for sync client.<br>\r
  17 It adopted Plugin mechanism so platfom-specific implementation can be independent.<br>\r
  18 \r
  19 User applications such as OMA DM/DS agent may utilize Sync-agent Framework APIs on purpose of Platform API usage or device manipulation.<br>\r
  20 \r
  21 Currently, Sync-agent Framework can be divided into 14 modules.<br>\r
  22 You can refer to detail explanation about each module through following sub page links.<br>\r
  23 \r
  24         - @subpage account "Account"\r
  25         - @subpage data_adapter "Data Adapter"\r
  26         - @subpage device "Device"\r
  27         - @subpage device_manager "Device Manager"\r
  28         - @subpage engine_controller "Engine Controller"\r
  29         - @subpage event "Event"\r
  30         - @subpage file_system "File System"\r
  31         - @subpage initialization "Initialization"\r
  32         - @subpage network_access "Network Access"\r
  33         - @subpage platform_monitor "Platform Monitor"\r
  34         - @subpage plugin_interface "Plugin Interface"\r
  35         - @subpage protocol_binder "Protocol Binder"\r
  36         - @subpage security_assistant "Security Assistant"\r
  37         - @subpage utility "Utility"\r
  38 \r
  39 In order for your client to use Sync-agent Framework, you need to write configuration in a file called Framework configuration XML.<br>\r
  40 Refer to following link for details about composition rule.<br>\r
  41         - @ref appendix_configuration "How to compose Framework configuration XML file"<br>\r
  42 \r
  43 And if you are willing to develope your own Plugins, there some guide lines.<br>\r
  44 Refer to following link for details about Plugin implementation.<br>\r
  45         - @ref appendix_plugin "How to implement your own Plugins"<br>\r
  46 \r
  47  @section Maintainers\r
  48  - WooJin Yun <suhoangel9@samsung.com>\r
  49  - Juhak Park <juhaki.park@samsung.com>\r
  50  - SangHyuk Ko <sanghyuk.ko@samsung.com>\r
  51  - Taewhan Gi  <th1128.gil@samsung.com>\r
  52  - Junhyeong Park <jruss.park@samsung.com>\r
  53 */\r