Skip to content
This repository
Browse code

[doc] DOCUMENTATION: added a DOCUMENTATION file for future usage

  • Loading branch information...
commit 85e602c3c1785b582242713d916b8669874235b9 1 parent 8c21ea1
Frederic Ye Aqua-Ye authored

Showing 1 changed file with 127 additions and 0 deletions. Show diff stats Hide diff stats

  1. +127 0 doc/book/DOCUMENTATION
127 doc/book/DOCUMENTATION
... ... @@ -0,0 +1,127 @@
  1 +Opa Documentation format :
  2 +
  3 +/**
  4 + * {1 Tests}
  5 + *
  6 + * [[**] ]
  7 + * [ [ **] ]
  8 + * [ [** ]]
  9 + * [[* *] ]
  10 + * [ [**] ]
  11 + * [ [**] [**] ]
  12 + * [ [ [**] ] ]
  13 + *
  14 + * [[]]
  15 + * [[][]]
  16 + * [[[]]]
  17 + * [{}]
  18 + * [{}{}]
  19 + * [{{}}]
  20 + *
  21 + * [[t[]]]
  22 + *
  23 + * {{}}
  24 + * {{}{}}
  25 + * {{{}}}
  26 + * {[]}
  27 + * {[][]}
  28 + * {[[]]}
  29 + *
  30 + * {[{t{}}}
  31 + * {[{% \emph{Hello \latex}}}
  32 + *
  33 + * {1 Syntax of documentation comments}
  34 + *
  35 + * Comments in an Opa file are parsed by opadoc to produce associated
  36 + * documentation. A special syntax can be used within these comments in order
  37 + * to organize the produced documentation and make it look better.
  38 + *
  39 + * You can either write independent documentation comments or associate them to
  40 + * code elements (functions, modules...) by placing them just before the
  41 + * element they describe.
  42 + *
  43 + * {2 Structure}
  44 + *
  45 + * You can use the following tags to organize the documentation into different
  46 + * parts.
  47 + *
  48 + * Square and curly brackets can be used inside formatting brackets without
  49 + * being escaped as long as they go in pair (opening and closing ones). If
  50 + * you'd like to use a single opening or closing bracket, you should escape it
  51 + * with a backslash.
  52 + *
  53 + * {3 Headings}
  54 + *
  55 + * {[
  56 + * {1 Heading1}
  57 + * {2 Heading2}
  58 + * {3 Heading3}
  59 + * {4 Heading4}
  60 + * {5 Heading5}
  61 + * {6 Heading6}
  62 + * }
  63 + *
  64 + * {3 Text formats}
  65 + *
  66 + * {4 Basic styles}
  67 + *
  68 + * {b bold}: [{b bold}]
  69 + *
  70 + * {it italic}: [{it italic}]
  71 + *
  72 + * {emp emphasize}: [{emp emphasize}]
  73 + *
  74 + * {^ superscript}: [{^ superscript}]
  75 + *
  76 + * {_ subscript}: [{_ subscript}]
  77 + *
  78 + * {4 Alignments }
  79 + *
  80 + * {C center} [{C
  81 + * center
  82 + * }]
  83 + * {L left} [{L
  84 + * left
  85 + * }]
  86 + * {R center} [{C
  87 + * center
  88 + * }]
  89 + *
  90 + * {4 Code}
  91 + *
  92 + * {[
  93 + * {[
  94 + * ...
  95 + * your code here
  96 + * ...
  97 + * }
  98 + * }
  99 + *
  100 + * {4 Verbatim}
  101 + *
  102 + * {[
  103 + * {v
  104 + * ...
  105 + * verbatim text here
  106 + * ...
  107 + * }
  108 + * }
  109 + *
  110 + * {4 Lists}
  111 + *
  112 + * {ul ul}
  113 + *
  114 + * {enum enum}
  115 + *
  116 + * {4 Raw LaTeX}
  117 + *
  118 + * {[
  119 + * {% \emph{Hello \latex}}
  120 + * }
  121 + *
  122 + * {4 Custom}
  123 + *
  124 + * {[
  125 + * {custom custom tag}
  126 + * }
  127 + */

0 comments on commit 85e602c

Please sign in to comment.
Something went wrong with that request. Please try again.