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%2Fdocumentation-guide.md;h=a1200e650963dd0a44a750930e41890714c8a4e7;hp=3be5549239a898479520ef73f7192d09f7ad08b9;hb=2d6ca096066a2f49ad96061dbf22a244b3343856;hpb=58f974300c5f41bdb34852cff825e2197eb13a9f

diff --git a/docs/content/shared-javascript-and-cpp-documentation/documentation-guide.md b/docs/content/shared-javascript-and-cpp-documentation/documentation-guide.md
index 3be5549..a1200e6 100644
--- a/docs/content/shared-javascript-and-cpp-documentation/documentation-guide.md
+++ b/docs/content/shared-javascript-and-cpp-documentation/documentation-guide.md
@@ -1,18 +1,44 @@
 /**
  *
-## Writing documentation for the DALi programing guide
+
+# Writing documentation for the DALi programing guide  {#documentationguide}
 
 To allow documentation to be shared between C++ and JavaScript, please follow these guidelines:
 
  - Create a mark down file (.md) using GitHub Flavoured Markdown https://help.github.com/articles/github-flavored-markdown/
- - Put it into the shared C++ / JavaScript documentation: ~dali-toolkit/docs/content/shared-javascript-and-cpp-documentation/~
+ - Put it into the shared C++ / JavaScript documentation: dali-toolkit/docs/content/shared-javascript-and-cpp-documentation/~
  - Include code samples for both C++ and JavaScript in the mark down.
- - See multi-touch-guide.md in toolkit for an example
+ - See script-overview.md overview in dali-toolkit/docs/content/shared-javascript-and-cpp-documentation for an example
+ - For YUIDOC to parse the file it needs:
+   - Enclosed in code comment block
+   - Have a class tag with a description of the file
+ - For DOXYGEN to link to the mark down it currently needs a reference {hash myfile}
+  
+
+#### Images
+ Images are shared between both Doxygen and YUIDOC tools using a symbolic link.
+ You need to link to the image twice in shared documentation.
+ This is because YUIDOC stores images in a folder called assets/img/  which is relative to the HTML pages.
+ Where as Doxygen copies all images in to the same folder as the HTML generated pages.
+
+ ~~~
+![ ](../assets/img/screen-shot.png)    // required for YUIDOC
+![ ](screen-shot.png)                  // required for Doxygen
+
+The space between the brackets is the alternative text. This means you will never see a broken image symbol.
+~~~
   
-Why use GitHub flavoured markdown?
+## Example
+![ ](../assets/img/example-documentation/example-code.png)
+![ ](example-code.png)
+
+
+
+#### Why use GitHub flavoured markdown?
  - Table support is good and language specific code blocks are easier to define ( javascript/C++).
  - Doxygen and YUIDOC both support it.
 
 
-@class Writing_DALi_Programming_Guide_Documentation
+@class _Guide_Writing_DALi_Programming_Guide_Documentation
+
 */