Merge "Added documentation markdown guide" into tizen
authorAdeel Kazmi <adeel.kazmi@samsung.com>
Fri, 13 Mar 2015 15:29:41 +0000 (08:29 -0700)
committerGerrit Code Review <gerrit@review.vlan103.tizen.org>
Fri, 13 Mar 2015 15:29:41 +0000 (08:29 -0700)
docs/content/shared-javascript-and-cpp-documentation/documentation-guide.md [new file with mode: 0644]

diff --git a/docs/content/shared-javascript-and-cpp-documentation/documentation-guide.md b/docs/content/shared-javascript-and-cpp-documentation/documentation-guide.md
new file mode 100644 (file)
index 0000000..3be5549
--- /dev/null
@@ -0,0 +1,18 @@
+/**
+ *
+## Writing documentation for the DALi programing guide
+
+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/~
+ - Include code samples for both C++ and JavaScript in the mark down.
+ - See multi-touch-guide.md in toolkit for an example
+  
+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
+*/