doc/internal.tex

   1 \documentclass[a4paper,10pt]{report}
   2 \usepackage[utf8x]{inputenc}
   3 \usepackage{indentfirst}
   4
   5 \author{Ethereal\\ethereal.visage@gmail.com}
   6 \title{Internals of the Aesalon visualization tool\\\normalsize{Document version 0.1}}
   7
   8 % Prevent 'Aesalon' from being broken by hyphenation.
   9 \hyphenation{Aesalon}
  10
  11 % The four arguments are:
  12 % - return type
  13 % - function name
  14 % - parameters
  15 % - description
  16 \newcommand{\documentFunction}[4]{
  17
  18   \emph{\textbf{#1 #2(}#3\textbf{)}}
  19   \begin{quotation}
  20
  21     #4
  22
  23   \end{quotation}
  24
  25 }
  26
  27 % The three arguments are:
  28 % - macro name
  29 % - parameters
  30 % - description
  31 \newcommand{\documentMacro}[3]{
  32
  33   \emph{\textbf{#1(}#2\textbf{)}}
  34   \begin{quotation}
  35
  36     #3
  37
  38   \end{quotation}
  39
  40 }
  41
  42 % The three arguments are:
  43 % - return type
  44 % - variable name
  45 % - description
  46 \newcommand{\documentVariable}[3]{
  47
  48   \emph{\textbf{#1 #2}}
  49   \begin{quotation}
  50
  51     #3
  52
  53   \end{quotation}
  54
  55 }
  56
  57 % The three arguments are:
  58 % - type name
  59 % - description
  60 % - \documentFunction/\documentType macros for the sub-types.
  61 \newcommand{\documentType}[2]{
  62
  63   \emph{\textbf{#1}}
  64   \begin{quotation}
  65
  66     #2
  67
  68   \end{quotation}
  69
  70 }
  71
  72 % The six arguments are:
  73 % - Class name
  74 % - return type
  75 % - function name
  76 % - parameters
  77 % - modifiers
  78 % - description
  79 \newcommand{\documentMethod}[6]{
  80
  81   \emph{\textbf{#2 #1::#3(}#4\textbf{) #5}}
  82   \begin{quotation}
  83
  84     #6
  85
  86   \end{quotation}
  87
  88 }
  89
  90 % The six arguments are:
  91 % - Class name
  92 % - type
  93 % - name
  94 % - description
  95 \newcommand{\documentProperty}[4]{
  96
  97   \emph{\textbf{#2 #1::#3}}
  98   \begin{quotation}
  99
 100     #4
 101
 102   \end{quotation}
 103
 104 }
 105
 106 \begin{document}
 107
 108 \setlength{\parindent}{1em}
 109 %\setlength{\parskip}{1ex}
 110
 111 %\maketitle
 112
 113 %\tableofcontents
 114
 115 %\include{internal_overview}
 116
 117 %\include{internal_implementation}
 118
 119 \include{internal_apis}
 120
 121 %\include{internal_appendix}
 122
 123 \end{document}