\item You will need \texttt{make} to build a pdf from the Doxygen LaTeX output.
\begin{itemize}\item\texttt{make} should be available by default on Linux systems.
\item If you are using OS X and \texttt{make} is not available, you will need to install the Command Line Tools package provided by Apple.
\item If you are using Windows, you should install the MinGW environment (\url{http://www.mingw.org/}). Make sure to add the MinGW bin folder to your path so that \texttt{make} is runnable from the command-line.
\item Depending on the complexity of the function, {\MVAt}details may not be necessary.
\item There should be an {\MVAt}param entry for every parameter of the function (possibly none). The parameter {\bf self} in class functions should be omitted.
\item{\MVAt}return is not necessary for void functions.
\item The Doxygen snippets given in this tutorial as well as the Box3D.py example file provide the basics for documenting your code.
\item Sometimes you may want to use additional commands to capture more details in your documentation.
\item Consult \url{http://www.stack.nl/~dimitri/doxygen/manual/commands.html} for the full listing of available documentation commands and descriptions.
\item Of particular importance for a new configuration are the PROJECT\_NAME (line 35) and INPUT (line 774) fields.
\item PROJECT\_NAME should be replaced with the name of the program you are documenting.
\item INPUT should list all of the source files you wish to be included in the documentation. Alternatively, you can
list a directory as INPUT and use FILE\_PATTERNS (line 799) to determine which files will be included.\\[10pt]
\item There are several other options you can use to customize your generated documentation. Refer to \url{http://www.stack.nl/~dimitri/doxygen/manual/config.html}.
\end{itemize}
\end{frame}
\begin{frame}[fragile]
\frametitle{Document Generation}
\begin{itemize}
\item Documentation is generated using the following command:
\begin{lstlisting}
doxygen configFileName
\end{lstlisting}
\item HTML and LaTeX documentation are default generated outputs.
\item By default, the HTML documentation will be found in a new directory called html: look for index.html.
\item The LaTeX documentation will be found in a new directory called latex. This folder will contain a makefile -- you must call make to generate a pdf which will be called refman.pdf by default.
\end{itemize}
\end{frame}
\begin{frame}[fragile]
\frametitle{Reference}
\begin{itemize}
\item Refer to the Doxygen documentation (\url{http://www.stack.nl/~dimitri/doxygen/manual/index.html}) for further details about using Doxygen.
\item You will need \texttt{make} to build a pdf from the Doxygen LaTeX output.
\begin{itemize}\item\texttt{make} should be available by default on Linux systems.
\item If you are using OS X and \texttt{make} is not available, you will need to install the Command Line Tools package provided by Apple.
\item If you are using Windows, you should install the \href{http://www.mingw.org/}{MinGW environment}. Make sure to add the MinGW bin folder to your path so that \texttt{make} is runnable from the command-line.
\item Depending on the complexity of the function, {\MVAt}details may not be necessary.
\item There should be an {\MVAt}param entry for every parameter of the function (possibly none). The parameter {\bf self} in class functions should be omitted.
\item{\MVAt}return is not necessary for void functions.
\item The Doxygen snippets given in this tutorial as well as the Box3D.py example file provide the basics for documenting your code.
\item Sometimes you may want to use additional commands to capture more details in your documentation.
\item Consult the \href{http://www.stack.nl/~dimitri/doxygen/manual/commands.html}{command documentation} for the full listing of available documentation commands and descriptions.
\item Of particular importance for a new configuration are the PROJECT\_NAME (line 35) and INPUT (line 774) fields.
\item PROJECT\_NAME should be replaced with the name of the program you are documenting.
\item INPUT should list all of the source files you wish to be included in the documentation. Alternatively, you can
list a directory as INPUT and use FILE\_PATTERNS (line 799) to determine which files will be included.\\[10pt]
\item There are several other options you can use to customize your generated documentation(refer to \href{http://www.stack.nl/~dimitri/doxygen/manual/config.html}{config documentation}).
\end{itemize}
\end{frame}
\begin{frame}[t,fragile]
\frametitle{Document Generation}
\begin{itemize}
\item Documentation is generated using the following command:
\begin{lstlisting}
doxygen configFileName
\end{lstlisting}
\item HTML and LaTeX documentation are default generated outputs.
\item By default, the HTML documentation will be found in a new directory called html: look for index.html.
\item The LaTeX documentation will be found in a new directory called latex. This folder will contain a makefile -- you must call make to generate a pdf which will be called refman.pdf by default.
\end{itemize}
\end{frame}
\begin{frame}[t,fragile]
\frametitle{Reference}
\begin{itemize}
\item Refer to the \href{http://www.stack.nl/~dimitri/doxygen/manual/index.html}{Doxygen documentation} for further details about using Doxygen.
