This is the subset of LaTeX formatting instructions provided by DOC++:When writing your documentation using only this, you can be sure to get reasonable LaTeX and HTML documentation for your code.
- $...$
- math mode for inline equations (example $\sqrt{\frac{x^2}2}$).
- \[...\]
- display math mode
- \#
- to output character #
- \_
- to output character "_"
- \
- to output character " "
- \em
- only to be used as {\em ...}
- \bf
- only to be used as {\bf ...}
- \it
- only to be used as {\it ...}
- \tt
- only to be used as {\tt ...}
- \tiny
- only to be used as {\tiny ...}
- \scriptsize
- only to be used as {\scriptsize ...}
- \footnotesize
- only to be used as {\footnotesize ...}
- \small
- only to be used as {\small ...}
- \large
- only to be used as {\large ...}
- \Large
- only to be used as {\Large ...}
- \LARGE
- only to be used as {\LARGE ...}
- \huge
- only to be used as {\huge ...}
- \Huge
- only to be used as {\Huge ...}
- \HUGE
- only to be used as {\HUGE ...}
- center
- i.e. \begin{center} ... \end{center}
- flushleft
- i.e. \begin{flushleft} ... \end{flushleft}
- flushright
- i.e. \begin{flushright} ... \end{flushright}
- verbatim
- i.e. \begin{verbatim} ... \end{verbatim}
- tabular
- i.e. \begin{tabular}{lll} ...&...\\ ... \end{tabular}
- itemize
- i.e. \begin{itemize} \item ... ... \end{itemize}
- enumerate
- i.e. \begin{enumerate} \item ... ... \end{enumerate}
- description
- i.e. \begin{description} \item[...] ... ... \end{description}
There are some additional LaTeX macros provided by DOC++:
- #...# corresponds to the LaTeX \verb!...!, i.e. outputs ... verbatim.
- \Ref{...} allows to specify a reference to a manual entry with name ....
- \URL{...} allows to specify a link to the WWW page ....
- \URL[my text]{...} allows to specify my text as the links name.
- \TEX{...} allows to include any complicated LaTeX code into you document. For HTML output DOC++ will have LaTeX to process it, produce gifs out of it and includes them into the HTML document. NOTE: This requires LaTeX, dvips, ghostscript and ppmtools to be correctly installed to your system!
this page has been generated automatically by doc++
(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de