Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

128 lines (126 sloc) 1.977 kb
Opa Documentation format :
/**
* {1 Tests}
*
* [[**] ]
* [ [ **] ]
* [ [** ]]
* [[* *] ]
* [ [**] ]
* [ [**] [**] ]
* [ [ [**] ] ]
*
* [[]]
* [[][]]
* [[[]]]
* [{}]
* [{}{}]
* [{{}}]
*
* [[t[]]]
*
* {{}}
* {{}{}}
* {{{}}}
* {[]}
* {[][]}
* {[[]]}
*
* {[{t{}}}
* {[{% \emph{Hello \latex}}}
*
* {1 Syntax of documentation comments}
*
* Comments in an Opa file are parsed by opadoc to produce associated
* documentation. A special syntax can be used within these comments in order
* to organize the produced documentation and make it look better.
*
* You can either write independent documentation comments or associate them to
* code elements (functions, modules...) by placing them just before the
* element they describe.
*
* {2 Structure}
*
* You can use the following tags to organize the documentation into different
* parts.
*
* Square and curly brackets can be used inside formatting brackets without
* being escaped as long as they go in pair (opening and closing ones). If
* you'd like to use a single opening or closing bracket, you should escape it
* with a backslash.
*
* {3 Headings}
*
* {[
* {1 Heading1}
* {2 Heading2}
* {3 Heading3}
* {4 Heading4}
* {5 Heading5}
* {6 Heading6}
* }
*
* {3 Text formats}
*
* {4 Basic styles}
*
* {b bold}: [{b bold}]
*
* {it italic}: [{it italic}]
*
* {emp emphasize}: [{emp emphasize}]
*
* {^ superscript}: [{^ superscript}]
*
* {_ subscript}: [{_ subscript}]
*
* {4 Alignments }
*
* {C center} [{C
* center
* }]
* {L left} [{L
* left
* }]
* {R center} [{C
* center
* }]
*
* {4 Code}
*
* {[
* {[
* ...
* your code here
* ...
* }
* }
*
* {4 Verbatim}
*
* {[
* {v
* ...
* verbatim text here
* ...
* }
* }
*
* {4 Lists}
*
* {ul ul}
*
* {enum enum}
*
* {4 Raw LaTeX}
*
* {[
* {% \emph{Hello \latex}}
* }
*
* {4 Custom}
*
* {[
* {custom custom tag}
* }
*/
Jump to Line
Something went wrong with that request. Please try again.