<html><head><meta name="color-scheme" content="light dark"></head><body><pre style="word-wrap: break-word; white-space: pre-wrap;">\documentclass{article}
\usepackage[T1]{fontenc}
\usepackage[ansinew]{inputenc}
\usepackage[ngerman]{babel}
\usepackage{csquotes}
\usepackage[section,toc1,deutsch,hyperref]{javadoc}

\hypersetup{colorlinks,citecolor=black,filecolor=black,linkcolor=black,urlcolor=black}

\author{Jolle\footnote{Verbesserungsvorschläge, Kommentare, Korrekturen, Anregungen und Danksagungen an \mbox{joerman.lieder@gmx.net}}  }
\date{\today}
\title{Dokumentation des TexGen-Doclets}

\begin{document}
\maketitle

\abstract{Diese Dokumentation beschreibt die Nutzung des TexGen-Doclets. Ein Doclet ist eine von com.sun.javadoc.Doclet abgeleitete Klasse, die verwendet werden kann, um mit dem Javadoc-Tool aus kommentierten Java-Quellcode-Dateien eine Dokumentation zu generieren. Standardmäßig werden HTML Dateien generiert, TexGen generiert \TeX-Dateien gemäß dem javadoc-Package. Das Doclet steht unter GNU GENERAL PUBLIC LICENSE\footnote{www.gnu.org}}

\tableofcontents

\section{Nutzung des Doclets}
\subsection{Aufruf von javadoc}
Um das Doclet zu nutzen muss es beim Aufruf von javadoc mit angegeben werden. Javadoc wird mit folgender Syntax aufgerufen:

javadoc [options] [packagenames] [sourcefiles] [@files]

Als mögliche Optionen existieren -doclet und -docletpath. Für das TexGen Doclet wird also hinter -doclet TexGen angegeben und hinter -docletpath der Pfad zum TexGen.jar Jararchiv.

\subsection{TexGen-eigene Option}
Das TexGen Doclet bietet eine eigene Option an. Hinter -dest wird der Pfad zu einem Ordner angegeben, in dem die generierten Dateien landen. Wird kein Pfad angegeben, wird an der ausgeführten Stelle ein texgendoc Ordner erstellt und verwendet.

Als Syntax ergibt sich somit:

javadoc -doclet TexGen -docletpath &lt;...texgen.jar&gt; -dest &lt;ausgabepath&gt;  ...

\subsection{Aufruf mit dem Eclipse Javadoc-Plugin}
Unter Eclipse kann Javadoc mittels eines Plugins aufgerufen werden. Hier gibt es die Möglichkeit, ein eigenes Doclet zu wählen. Unter Docletname wird wieder TexGen angegeben, unter DocletPath der Pfad des Jararchives. Auf der nächsten Seite wird die Möglichkeit gegeben, \enquote{Extra Javadoc Options} anzugegeben. Hier kann -dest &lt;ausgabepath&gt; eingetragen werden.

\section{Hinweise}
\begin{itemize}
	\item Bestimmte Sonderzeichen im dokumentierenden Text werden umgewandelt, um sie nicht als Tex-Steuerzeichen zu interpretieren. Dazu gehören:
\verb+{ } _ ^ &amp; # [ ]+. Es wird also schwer, Tex-Befehle in den Quelltext zu schreiben, um die Ausgabe zu formatieren. Es ist Aufgabe des Dokumentators zu prüfen, welche Zeichen in der Beschreibung vorkommen.
	\item Bisher werden noch keine generischen Datentypen behandelt.
	\item Doppelte Klassenamen (z.b. in verschiedenen Packages) werden zwar getrennt behandelt, aber bei der internen Verlinkung nicht unterschieden.
\end{itemize}

\section{Dokumentation des Quellcodes}

\input{doc/TexGen}
\input{doc/ClassWriter}
\input{doc/TexPrintStream}
\input{doc/InhTable}
\input{doc/InhEntry}


\end{document}</pre></body></html>