From e7e1158cd9d616366611655e454041a5821f78f5 Mon Sep 17 00:00:00 2001 From: Nick Holland Date: Fri, 6 Mar 2015 15:39:50 +0000 Subject: [PATCH] Added documentation markdown guide Change-Id: I8cbb65d434b74b60f4cf5c62c8d4865c4d7c97eb --- .../documentation-guide.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 docs/content/shared-javascript-and-cpp-documentation/documentation-guide.md 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 index 0000000..3be5549 --- /dev/null +++ b/docs/content/shared-javascript-and-cpp-documentation/documentation-guide.md @@ -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 +*/ -- 2.7.4