X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=docs%2Fcontent%2Fshared-javascript-and-cpp-documentation%2Fdocumentation-guide.md;h=af3b3e74975d0f7ef31d468632670b929d15bd84;hb=daa53bafd34781116b8cb3a2a8c54475a932ba21;hp=a1200e650963dd0a44a750930e41890714c8a4e7;hpb=659d0ae8e8c828cb46fad7448b37ff9b7062819d;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git 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 a1200e6..af3b3e7 100644 --- a/docs/content/shared-javascript-and-cpp-documentation/documentation-guide.md +++ b/docs/content/shared-javascript-and-cpp-documentation/documentation-guide.md @@ -1,5 +1,5 @@ -/** - * + # Writing documentation for the DALi programing guide {#documentationguide} @@ -29,10 +29,26 @@ The space between the brackets is the alternative text. This means you will neve ~~~ ## Example -![ ](../assets/img/example-documentation/example-code.png) -![ ](example-code.png) +Please have a look at the numerous markdown files to see the header and footer requirements. +You can add tags to your headings as follows: +~~~{.md} +# MyChapter {#my-chapter} +~~~ +Which will allow you to link to this section as follows: +~~~{.md} +[Go To MyChapter](@ref my-chapter) +~~~ + +Code blocks can be enclosed within 2 blocks of 3 tildas(~). + +You can even specify your language type, for example: +~~~{.md} +~~~{.cpp} +... +~~~{.js} +~~~ #### Why use GitHub flavoured markdown? - Table support is good and language specific code blocks are easier to define ( javascript/C++).