X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=docs%2Fcontent%2Fshared-javascript-and-cpp-documentation%2Fjavascript-wrapping-guide.md;h=b2eef34ddf7bd320207aca4ab000c4ca26e75430;hp=50dd02223503831a50fb1550c111c34d64a28b1b;hb=74c8fd064793430f586e7f2572e3a0bd0fb50af4;hpb=6843654a76dd5ac486ec3dc69e32798023dda176 diff --git a/docs/content/shared-javascript-and-cpp-documentation/javascript-wrapping-guide.md b/docs/content/shared-javascript-and-cpp-documentation/javascript-wrapping-guide.md index 50dd022..b2eef34 100644 --- a/docs/content/shared-javascript-and-cpp-documentation/javascript-wrapping-guide.md +++ b/docs/content/shared-javascript-and-cpp-documentation/javascript-wrapping-guide.md @@ -1,5 +1,6 @@ -/** - * + + # JavaScript wrapping guide {#javascriptwrapping} This guide outlines what files to modify when the DALi C++ public API changes. @@ -27,7 +28,7 @@ The current file / folder structure is as follows: ### New property has been added - No code change required. -- It will be automatically avalable using the dot notation. E.g. actor.my_new_property = true; +- It will be automatically available using the dot notation. E.g. actor.my_new_property = true; ### New property type has been added - modify property-value-wrapper.h / .cpp to support the new type @@ -35,7 +36,7 @@ The current file / folder structure is as follows: ### New function added to an object - Add the function name to function table in my-object-wrapper.cpp - Add the forwarding function to my-object-api.cpp/.h -- Ensure you have created YUIDOC documention above the function +- Ensure you have created YUIDOC documentation above the function ![ ](../assets/img/javascript-wrapping-guide/adding-function.png) ![ ](adding-function.png) @@ -67,7 +68,7 @@ var light = new dali.Light(); If Light inherits from Handle then use path-wrapper and path-api as a template to create light-wrapper and light-api ( inherits from HandleWrapper) -Otherwise use animation-wrapper and animation-api as a template ( inherts from BaseWrappedObject) +Otherwise use animation-wrapper and animation-api as a template ( inherits from BaseWrappedObject) @@ -104,10 +105,11 @@ v8 will detect myActor is a wrapped object, and call getId() on that wrapped obj The wrapped object, then forwards the command to the real DALi object. Whenever we want to access functions / properties of that wrapped object, we unwrap it -to get access to the Dali object. +to get access to the DALi object. -Each wrapped object registers with Dali garbage collector so they can be deleted -when Dali shuts down +Each wrapped object registers with DALi garbage collector so they can be deleted +when DALi shuts down + +@class _Guide_JavaScript_Wrapping -@class _Guide_JavaScript_Wrapping` -*/ \ No newline at end of file +*/