Commit de4536f0 authored by POTTIER Francois's avatar POTTIER Francois
Browse files

Documentation: new TeX macros.

parent e475d824
...@@ -28,6 +28,7 @@ ...@@ -28,6 +28,7 @@
\newcommand{\dpublic}{\kw{\%public}\xspace} \newcommand{\dpublic}{\kw{\%public}\xspace}
\newcommand{\dinline}{\kw{\%inline}\xspace} \newcommand{\dinline}{\kw{\%inline}\xspace}
\newcommand{\donerrorreduce}{\kw{\%on\_error\_reduce}\xspace} \newcommand{\donerrorreduce}{\kw{\%on\_error\_reduce}\xspace}
\newcommand{\dattribute}{\kw{\%attribute}\xspace}
\newcommand{\dpaction}[1]{\kw{\{} #1 \kw{\}}\xspace} \newcommand{\dpaction}[1]{\kw{\{} #1 \kw{\}}\xspace}
\newcommand{\daction}{\dpaction{\textit{\ocaml code}}\xspace} \newcommand{\daction}{\dpaction{\textit{\ocaml code}}\xspace}
\newcommand{\dprec}{\kw{\%prec}\xspace} \newcommand{\dprec}{\kw{\%prec}\xspace}
...@@ -48,18 +49,29 @@ ...@@ -48,18 +49,29 @@
\newcommand{\docswitch}[1]{\vspace{1mm plus 1mm}#1.\hskip 3mm} \newcommand{\docswitch}[1]{\vspace{1mm plus 1mm}#1.\hskip 3mm}
\newcommand{\error}{\kw{error}\xspace} \newcommand{\error}{\kw{error}\xspace}
% Links to Menhir's repository.
\newcommand{\repo}[2]{\href{https://gitlab.inria.fr/fpottier/menhir/blob/master/#1}{#2}}
\newcommand{\menhirlibconvert}{\repo{src/Convert.mli}{\texttt{MenhirLib.Convert}}\xspace}
\newcommand{\menhirlibincrementalengine}{\repo{src/IncrementalEngine.ml}{\texttt{MenhirLib.IncrementalEngine}}\xspace}
% Links to CompCert's repository.
\newcommand{\compcertgithub}{https://github.com/AbsInt/CompCert/tree/master}
\newcommand{\compcertgithubfile}[1]{\href{\compcertgithub/#1}{\texttt{#1}}}
% Abbreviations. % Abbreviations.
\newcommand{\menhir}{Menhir\xspace} \newcommand{\menhir}{Menhir\xspace}
\newcommand{\menhirlib}{\texttt{MenhirLib}\xspace} \newcommand{\menhirlib}{\texttt{MenhirLib}\xspace}
\newcommand{\menhirlibconvert}{\href{http://gallium.inria.fr/~fpottier/menhir/Convert.mli.html}{\texttt{MenhirLib.Convert}}\xspace} \newcommand{\menhirsdk}{\texttt{MenhirSdk}\xspace}
\newcommand{\menhirinterpreter}{\texttt{MenhirInterpreter}\xspace} \newcommand{\menhirinterpreter}{\texttt{MenhirInterpreter}\xspace}
\newcommand{\menhirlibincrementalengine}{\href{http://gallium.inria.fr/~fpottier/menhir/IncrementalEngine.ml.html}{\texttt{MenhirLib.IncrementalEngine}}\xspace}
\newcommand{\menhirlibgeneral}{\href{http://gallium.inria.fr/~fpottier/menhir/General.mli.html}{\texttt{MenhirLib.General}}\xspace}
\newcommand{\cmenhir}{\texttt{menhir}\xspace} \newcommand{\cmenhir}{\texttt{menhir}\xspace}
\newcommand{\ml}{\texttt{.ml}\xspace} \newcommand{\ml}{\texttt{.ml}\xspace}
\newcommand{\mli}{\texttt{.mli}\xspace} \newcommand{\mli}{\texttt{.mli}\xspace}
\newcommand{\mly}{\texttt{.mly}\xspace} \newcommand{\mly}{\texttt{.mly}\xspace}
\newcommand{\cmly}{\texttt{.cmly}\xspace}
\newcommand{\vy}{\texttt{.vy}\xspace}
\newcommand{\ocaml}{OCaml\xspace} \newcommand{\ocaml}{OCaml\xspace}
\newcommand{\ocamlc}{\texttt{ocamlc}\xspace} \newcommand{\ocamlc}{\texttt{ocamlc}\xspace}
\newcommand{\ocamlopt}{\texttt{ocamlopt}\xspace} \newcommand{\ocamlopt}{\texttt{ocamlopt}\xspace}
...@@ -104,6 +116,7 @@ ...@@ -104,6 +116,7 @@
\newcommand{\obase}{\texttt{-{}-base}\xspace} \newcommand{\obase}{\texttt{-{}-base}\xspace}
\newcommand{\ocanonical}{\texttt{-{}-canonical}\xspace} % undocumented! \newcommand{\ocanonical}{\texttt{-{}-canonical}\xspace} % undocumented!
\newcommand{\ocomment}{\texttt{-{}-comment}\xspace} \newcommand{\ocomment}{\texttt{-{}-comment}\xspace}
\newcommand{\ocmly}{\texttt{-{}-cmly}\xspace}
\newcommand{\odepend}{\texttt{-{}-depend}\xspace} \newcommand{\odepend}{\texttt{-{}-depend}\xspace}
\newcommand{\orawdepend}{\texttt{-{}-raw-depend}\xspace} \newcommand{\orawdepend}{\texttt{-{}-raw-depend}\xspace}
\newcommand{\odump}{\texttt{-{}-dump}\xspace} \newcommand{\odump}{\texttt{-{}-dump}\xspace}
...@@ -159,9 +172,5 @@ ...@@ -159,9 +172,5 @@
\renewcommand{\basic}[1]{$\mathstrut$\oldbasic{##1}} \renewcommand{\basic}[1]{$\mathstrut$\oldbasic{##1}}
} }
% URLs.
\newcommand{\compcertgithub}{https://github.com/AbsInt/CompCert/tree/master}
\newcommand{\compcertgithubfile}[1]{\href{\compcertgithub/#1}{\texttt{#1}}}
% Position keywords. % Position keywords.
\newcommand{\ksymbolstartpos}{\texttt{\$symbolstartpos}\xspace} \newcommand{\ksymbolstartpos}{\texttt{\$symbolstartpos}\xspace}
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment