docs/content/shared-javascript-and-cpp-documentation/documentation-guide.md

   1 /**
   2  *
   3 ## Writing documentation for the DALi programing guide
   4
   5 To allow documentation to be shared between C++ and JavaScript, please follow these guidelines:
   6
   7  - Create a mark down file (.md) using GitHub Flavoured Markdown https://help.github.com/articles/github-flavored-markdown/
   8  - Put it into the shared C++ / JavaScript documentation: ~dali-toolkit/docs/content/shared-javascript-and-cpp-documentation/~
   9  - Include code samples for both C++ and JavaScript in the mark down.
  10  - See multi-touch-guide.md in toolkit for an example
  11
  12 Why use GitHub flavoured markdown?
  13  - Table support is good and language specific code blocks are easier to define ( javascript/C++).
  14  - Doxygen and YUIDOC both support it.
  15
  16
  17 @class Writing_DALi_Programming_Guide_Documentation
  18 */