curioustorvald/tsvm
1
0
Fork 0
mirror of https://github.com/curioustorvald/tsvm.git synced 2026-03-14 06:56:05 +09:00
Code Issues Packages Projects Releases Wiki Activity

doc: more macros for uniform doc style

Browse Source
This commit is contained in:
minjaesong
2022-08-27 13:46:18 +09:00
parent e91fac4fb5
commit b41ff1c834
3 changed files with 95 additions and 106 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
doc/tsvmman.tex
View File

@@ -42,6 +42,7 @@
\usepackage{anyfontsize}
\usepackage{cancel}
\usepackage{outlines}
\usepackage{xparse}
\usepackage{lineno} % debug
@@ -72,6 +73,23 @@
\newcommand{\namespaceis}[2]{\index{#2 (library)}The functions in the #1 library can be found under the \textbf{#2} namespace.}
\newcommand{\dosnamespaceis}[2]{\index{#2 (DOS)}The functions in the \thedos\ #1 library can be found under the \textbf{#2} namespace.}
% usage: \inlinesynopsis{any name}{description}
% usage: \inlinesynopsis{function name}{arguments info}{description}
% usage: \inlinesynopsis[namespace]{any name}{description}
% usage: \inlinesynopsis[namespace]{function name}{arguments info}{description}
\NewDocumentCommand\inlinesynopsis{ommg}{%
\IfNoValueF{#1}{#1.}\textbf{#2}\IfNoValueTF{#4}{ --- #3}{(#3) --- #4}%
}
% usage: \formalsynopsis{function name}{arguments info}[return type]{description}
% usage: \formalsynopsis{function name}{arguments info}{description}
\NewDocumentCommand\formalsynopsis{mmom}{%
\textbf{#1}(#2)\IfNoValueF{#3}{: #3}\\#4%
}
\newcommand\propertysynopsis[3]{\textbf{#1}: #2\\#3}
\newcommand\argsynopsis[2]{\textbf{#1}: #2}
\newcommand\forceindent{\hskip1.5em}
%% BASIC operators %%
@@ -80,6 +98,8 @@
\newcommand{\instbitrange}[2]{~\instbit{#1} \hfill \instbit{#2}~}
% Title styling
% \pretitle{\begin{flushright}}
% \posttitle{\par\end{flushright}}