Doc headers

[bbtk.git] / kernel / doc / bbtkDevelopersGuide / bbtkDevelopersGuide.tex

diff --git a/kernel/doc/bbtkDevelopersGuide/bbtkDevelopersGuide.tex b/kernel/doc/bbtkDevelopersGuide/bbtkDevelopersGuide.tex
index f35e947b7f5438b5e5010028d1005e80d3a54b2f..f48f68f0535a1a00bf56d60ec135a4c83d7dcdef 100644 (file)
--- a/kernel/doc/bbtkDevelopersGuide/bbtkDevelopersGuide.tex
+++ b/kernel/doc/bbtkDevelopersGuide/bbtkDevelopersGuide.tex
@@ -2,75 +2,52 @@
 \input{config.tex}
 
 
-\def\todo{\scriptsize\fbox{\bf TODO !!}\normalsize}
-\def\x{\bm{x}}
-\def\BBTK{{\xspace}The {\bf Black Box Toolkit} }
-\def\bbtk{{\xspace}$\texttt{bbtk}$ }
-\def\bbi{{\xspace}$\texttt{bbi}$ }
-\def\bbStudio{{\xspace}$\texttt{bbStudio}$ }
-\def\bbfy{{\xspace}$\texttt{bbfy}$ }
-\def\bbdoc{{\xspace}$\texttt{bbdoc}$ }
-\def\bbCreatePackage{{\xspace}$\texttt{bbCreatePackage}$ }
 
-\def\bb{{\xspace}$\texttt{bb}$ }
-%\def\bbp{{\xspace}$\texttt{bbp}$\xspace}
-
-\def\cmake{{\xspace}$\texttt{cmake}$ }
-
-\def\C{{\xspace}$\texttt{C}$ }
-\def\CPP{{\xspace}$\texttt{C++}$ }
-
-\def\xml{{\xspace}$\texttt{xml}$ }
-
-\def\itk{{\xspace}$\texttt{itk}$ }
-\def\vtk{{\xspace}$\texttt{vtk}$ }
-\def\gdcm{{\xspace}$\texttt{gdcm}$ }
-\def\gsmis{{\xspace}$\texttt{gsmis}$ }
-\def\wx{{\xspace}$\texttt{wxWidgets}$ }
-
-\def\lin{{\xspace}\textit{Linux} }
-\def\win{{\xspace}\textit{Windows} }
-
-% the same macros with no space at the end
+\begin{document}
 
-\def\BBTKns{{\xspace}The {\bf Black Box Toolkit}}
-\def\bbtkns{{\xspace}$\texttt{bbtk}$}
-\def\bbins{{\xspace}$\texttt{bbi}$}
-\def\bbfyns{{\xspace}$\texttt{bbfy}$}
-\def\bbdocns{{\xspace}$\texttt{bbdoc}$}
-\def\bbCreatePackagens{{\xspace}$\texttt{bbCreatePackage}$}
+\begin{center}
 
-\def\bbns{{\xspace}$\texttt{bb}$}
-%\def\bbp{{\xspace}$\texttt{bbp}$\xspace}
+{\Large \BBTK}
+\vspace{1cm}
 
-\def\cmakens{{\xspace}$\texttt{cmake}$}
+{\Huge Developers' Guide}
+\vspace{1cm}
 
-\def\Cns{{\xspace}$\texttt{C}$}
-\def\CPPns{{\xspace}$\texttt{C++}$}
+\bbtk version \bbtkVersion
+\vspace{0.5cm}
 
-\def\xmlns{{\xspace}$\texttt{xml}$}
 
-\def\itkns{{\xspace}$\texttt{itk}$}
-\def\vtkns{{\xspace}$\texttt{vtk}$}
-\def\gdcmns{{\xspace}$\texttt{gdcm}$}
-\def\gsmisns{{\xspace}$\texttt{gsmis}$}
-\def\wxns{{\xspace}$\texttt{wxWidgets}$}
+Last modified on : September 16, 2008 \\
+Generated on : \today 
+\vspace{0.5cm}
+\end{center}
+\begin{center}
+Eduardo Davila, Laurent Guigues, Jean-Pierre Roux 
+\end{center}
+\begin{center}
+CREATIS-LRMN, Centre de Recherche en Imagerie Medicale \\ CNRS UMR 5220, INSERM U620\\
+INSA Lyon\\
+Universit\'e Claude-Bernard Lyon 1
+\end{center}
 
-\def\linns{{\xspace}\textit{Linux}}
-\def\winns{{\xspace}\textit{Windows}}
 
-\author{L. Guigues}
-\title{The Black Box Tool Kit\\Developers' Guide}
 
-\begin{document}
-\maketitle
+% ==========================================
 \tableofcontents
+% ==========================================
+
 \chapter{Introduction}
 
 
 \chapter{Misc}
+
 \section{Displaying messages}
 
+\begin{verbatim}
+bbtkMessage("Kind",level,"message "<<"to "<<" display : i="<<i<<std::endl);
+bbtkDebugMessage("Kind",level,"message "<<"to "<<" display : i="<<i<<std::endl);
+\end{verbatim}
+
 \section{Types and RTTI}
 
 
@@ -83,7 +60,7 @@ which is simply a typedef on
 \begin{verbatim}
 const std::type_info&
 \end{verbatim}
-Remember that all constructors ofthe std::type\_info class are private, 
+Remember that all constructors of the std::type\_info class are private, 
 hence objects can only be created by the operator \texttt{typeid} 
 which returns a const reference on a type\_info. 
 Hence the \bbtk type TypeInfo conveys that const reference