From: Mateusz Bruno-Kaminski Date: Thu, 1 Dec 2016 09:31:07 +0000 (+0100) Subject: [Devel package] Doc update X-Git-Tag: submit/tizen_3.0/20161215.084621~5^2 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F10%2F101510%2F6;p=platform%2Fcore%2Fapi%2Fwebapi-plugins.git [Devel package] Doc update [Details] Commited changes in Markdown files, generated HTML files from Markdown. Change-Id: I318362dfe46ac217cb9e37b456eda1fc3a6c8c45 Signed-off-by: Mateusz Bruno-Kaminski --- diff --git a/doc/Tizen Avengers - WebApi Guidelines.pdf b/doc/Tizen Avengers - WebApi Guidelines.pdf index 819d9428..ac6172fc 100644 Binary files a/doc/Tizen Avengers - WebApi Guidelines.pdf and b/doc/Tizen Avengers - WebApi Guidelines.pdf differ diff --git a/doc/html/index.html b/doc/html/index.html index cf82f401..1328643e 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -12,7 +12,7 @@
- +
Generated by Doctor, MD @@ -35,49 +35,49 @@ 0.1.0 2015-05-15 Initial Draft -Wojciech Kosowicz
w.kosowicz@samsung.com +Wojciech Kosowicz
w.kosowicz@samsung.com 0.2.0 2015-05-22 Extended version -Pawel Kaczmarek
p.kaczmarek3@samsung.com +Pawel Kaczmarek
p.kaczmarek3@samsung.com 0.2.1 2015-06-01 Proofreading -Rafal Galka
r.galka@samsung.com +Rafal Galka
r.galka@samsung.com 0.3.0 2015-06-08 Supplemented C++ implementation guide -Rafal Galka
r.galka@samsung.com +Rafal Galka
r.galka@samsung.com 0.4.0 2015-06-16 Guideline -Pawel Kaczmarek
p.kaczmarek3@samsung.com +Pawel Kaczmarek
p.kaczmarek3@samsung.com 0.5.0 2015-06-18 Devel package -Pawel Kaczmarek
p.kaczmarek3@samsung.com +Pawel Kaczmarek
p.kaczmarek3@samsung.com 0.5.1 2015-06-24 Add info about WAPIOven.py -Pawel Kaczmarek
p.kaczmarek3@samsung.com +Pawel Kaczmarek
p.kaczmarek3@samsung.com 0.6.0 2016-10-28 update devel package for tizen 3.0 -Annie Park
hj.na.park@samsung.com +Annie Park
hj.na.park@samsung.com @@ -143,9 +143,14 @@ $ git checkout origin/tizen_3.0

Spec file

Spec file (webapi-plugins.spec) kept inside packaging/ directory -is build specification file used by rpm packaging system where variables are defined. +is build specification file used by RPM packaging system where variables are defined. Those variables can be used to include or exclude particular modules from build for each profile (mobile, TV, wearable).

+

Manifest file

+

Each RPM package must have a manifest file where developers can specify the access control domain +in which their application should be running and potentially additional security policies for the +application. It is necessary to build the project. The manifest file (webapi-plugins.manifest) +is located in the root directory of the project.

GYP file

Each plugin has its own gyp file that contains information specific for it. Plugin configuration file (gyp) is the equivalent of CMake. @@ -484,7 +489,9 @@ native.callSync('Calendar_addChangeListener', {

All plugins instances are created by runtime on application launch. It's important to not initialize any database/service connections and platform handlers in instance constructor. All resources should be "lazy" initialized -just before first use, to keep starting time as short as possible. +just before first use, to keep starting time as short as possible. At the beginning +the initializer loads only basic information from plugins.json. This file is being +generated during plugins build process, its body depends on defined modules. Initialized resources can be referenced to instance and kept for further usage. Instance destructor is called on application termination and should release all used resources to prevent memory leaks.

@@ -494,8 +501,9 @@ Example: If operation should change some object retrieved from platform, identifier should be passed again and additional check if object still exists should be made.

Privileges

-

Some of the API methods require privilege access. In Tizen 3.0 checking if application has privilege -to call method has been moved to C++ layer. It's the first step which should be checked.

+

Some of the API methods require privilege access. The privilege engine used in the project is Cynara. +In Tizen 3.0 checking if application has privilege to call method has been moved to C++ layer. It's the +first step which should be checked.

Below can be found example of using Privilege in Alarm API:

const std::string kPrivilegeAlarm = "http://tizen.org/privilege/alarm.get";
 
@@ -658,6 +666,10 @@ Package contains required common headers files, gypi files and webapi-plugins.pc
 |-----------pylib
 |-------------gyp
 |---------------generator
+|---------slimit
+|-----------ply
+|-----------tests
+|-----------visitors
 |---lib
 |-----pkgconfig
diff --git a/doc/src/devel_package.md b/doc/src/devel_package.md index c6b9e4c6..0f970f1e 100644 --- a/doc/src/devel_package.md +++ b/doc/src/devel_package.md @@ -15,6 +15,10 @@ Package contains required common headers files, gypi files and webapi-plugins.pc |-----------pylib |-------------gyp |---------------generator +|---------slimit +|-----------ply +|-----------tests +|-----------visitors |---lib |-----pkgconfig ``` diff --git a/doc/src/implementation_cc.md b/doc/src/implementation_cc.md index 9795bfca..c6d84e51 100644 --- a/doc/src/implementation_cc.md +++ b/doc/src/implementation_cc.md @@ -5,7 +5,9 @@ All plugins instances are created by runtime on application launch. It's important to not initialize any database/service connections and platform handlers in instance constructor. All resources should be "lazy" initialized -just before first use, to keep starting time as short as possible. +just before first use, to keep starting time as short as possible. At the beginning +the initializer loads only basic information from plugins.json. This file is being +generated during plugins build process, its body depends on defined modules. Initialized resources can be referenced to instance and kept for further usage. Instance destructor is called on application termination and should release all used resources to prevent memory leaks. @@ -18,8 +20,9 @@ should be made. ### Privileges -Some of the API methods require privilege access. In Tizen 3.0 checking if application has privilege -to call method has been moved to C++ layer. It's the first step which should be checked. +Some of the API methods require privilege access. The privilege engine used in the project is Cynara. +In Tizen 3.0 checking if application has privilege to call method has been moved to C++ layer. It's the +first step which should be checked. Below can be found example of using Privilege in Alarm API: diff --git a/doc/src/plugin_structure.md b/doc/src/plugin_structure.md index 536bebe7..161b0d4a 100644 --- a/doc/src/plugin_structure.md +++ b/doc/src/plugin_structure.md @@ -17,10 +17,17 @@ Each plugin contains following structure: ### Spec file Spec file (```webapi-plugins.spec```) kept inside ```packaging/``` directory -is build specification file used by rpm packaging system where variables are defined. +is build specification file used by RPM packaging system where variables are defined. Those variables can be used to include or exclude particular modules from build for each profile (mobile, TV, wearable). +### Manifest file + +Each RPM package must have a manifest file where developers can specify the access control domain +in which their application should be running and potentially additional security policies for the +application. It is necessary to build the project. The manifest file (```webapi-plugins.manifest```) +is located in the root directory of the project. + ### GYP file Each plugin has its own gyp file that contains information specific for it.