diff options
Diffstat (limited to 'macros/latex/contrib/javadoc/doclet/doc/ClassWriter.tex')
-rw-r--r-- | macros/latex/contrib/javadoc/doclet/doc/ClassWriter.tex | 308 |
1 files changed, 308 insertions, 0 deletions
diff --git a/macros/latex/contrib/javadoc/doclet/doc/ClassWriter.tex b/macros/latex/contrib/javadoc/doclet/doc/ClassWriter.tex new file mode 100644 index 0000000000..a008c3e671 --- /dev/null +++ b/macros/latex/contrib/javadoc/doclet/doc/ClassWriter.tex @@ -0,0 +1,308 @@ +\begin{jdclass}[class]{ClassWriter} +\begin{jdclassheader} + +\jdpublic +\jdinherits{\jdtypesimple{Object}} +\JDtext{Class that collection the javadoc information for one class and writes them in to the destination file.} +\JDauthor{Jolle} +\JDsince{13.05.2008} +\JDversion{1.0} +\end{jdclassheader} +\begin{jdinheritancetable} \jdInhEntry{\jdtypesimple{Object} clone( )}{Object} + \jdInhEntry{\jdtypesimple{boolean} equals( \jdtypesimple{Object} )}{Object} + \jdInhEntry{\jdtypesimple{void} finalize( )}{Object} + \jdInhEntry{\jdtypesimple{Class} getClass( )}{Object} + \jdInhEntry{\jdtypesimple{int} hashCode( )}{Object} + \jdInhEntry{\jdtypesimple{void} notify( )}{Object} + \jdInhEntry{\jdtypesimple{void} notifyAll( )}{Object} + \jdInhEntry{\jdtypesimple{String} toString( )}{Object} + \jdInhEntry{\jdtypesimple{void} wait( \jdtypesimple{long} )}{Object} + \jdInhEntry{\jdtypesimple{void} wait( \jdtypesimple{long}, \jdtypesimple{int} )}{Object} + \jdInhEntry{\jdtypesimple{void} wait( )}{Object} +\end{jdinheritancetable} +\begin{jdfield}{JDclass} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDheader} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDmethod} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDconstructor} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDfield} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDinterfaceOpt} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDclassOpt} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDCpublic} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDCprivate} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDCprotected} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDCfinal} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDCstatic} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDCtransient} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDCvolatile} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDCabstract} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDCpackage} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDCinherits} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDCinhArrow} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDCimplements} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDCouterclass} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDCtype} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDcategory} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDdeprecated} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDsee} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDserial} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDserialData} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDserialField} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDsince} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDtext} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDversion} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDreturn} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDauthor} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDpara} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDthrows} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDinhtable} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDClinksimple} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{JDClinkarray} +\jdprivate \jdfinal \jdstatic +\jdtype{\jdtypesimple{String}} +\end{jdfield} +\begin{jdfield}{ps\_dateiausgabe} +\jdprivate +\jdtype{\jdtypesimple{TexPrintStream}} +\JDtext{Stream, the output is written to.} +\JDauthor{Jolle} +\JDsince{version 1.0 from 13.05.2008} +\end{jdfield} +\begin{jdconstructor} +\jdpublic +\JDpara{\jdtypesimple{String}}{s\_zielpath}{path with the destination file} +\JDthrows{IOException}{If the file cannot be created.} +\JDthrows{FileNotFoundException}{If the file isn't available after creation process} +\JDtext{Initializes the ClassWriter, creating a new file with a stream into} +\JDauthor{Jolle} +\JDsince{version 1.0 of 13.05.2008} +\end{jdconstructor} +\begin{jdmethod}{print} +\jdpublic +\jdtype{\jdtypesimple{void}} +\JDpara{\jdtypesimple{ClassDoc}}{cd}{class-object} +\JDtext{Writes the information of this file} +\JDsince{version 1.0 from 13.05.2008} +\JDauthor{Jolle} +\end{jdmethod} +\begin{jdmethod}{print} +\jdprivate +\jdtype{\jdtypesimple{void}} +\JDpara{\jdtypesimple{FieldDoc}}{fd}{field-object} +\JDtext{Writes the information of a field} +\JDsince{version 1.0 from 13.05.2008} +\JDauthor{Jolle} +\end{jdmethod} +\begin{jdmethod}{print} +\jdprivate +\jdtype{\jdtypesimple{void}} +\JDpara{\jdtypesimple{ConstructorDoc}}{cd}{constructor-object} +\JDtext{Writes the informationen of a constructor} +\JDsince{version 1.0 from 13.05.2008} +\JDauthor{Jolle} +\end{jdmethod} +\begin{jdmethod}{print} +\jdprivate +\jdtype{\jdtypesimple{void}} +\JDpara{\jdtypesimple{MethodDoc}}{md}{method-object} +\JDtext{Writes the information of a method} +\JDsince{version 1.0 from 13.05.2008} +\JDauthor{Jolle} +\end{jdmethod} +\begin{jdmethod}{printTags} +\jdprivate +\jdtype{\jdtypesimple{void}} +\JDpara{\jdtypesimple{Doc}}{d}{Doc-Type with the javadoc-information} +\JDtext{Writes all primitv javadoc attributes} +\JDsince{version 1.0 from 13.05.2008} +\JDauthor{Jolle} +\end{jdmethod} +\begin{jdmethod}{printClassInfo} +\jdprivate +\jdtype{\jdtypesimple{InhTable}} +\JDpara{\jdtypesimple{ClassDoc}}{cd}{Class-object} +\JDtext{Writes the classheader} +\JDsince{version 1.0 from 13.05.2008} +\JDauthor{Jolle} +\JDreturn{The tableOfInheritance is created in this method and returned for later use.} +\end{jdmethod} +\begin{jdmethod}{getLinks} +\jdpublic \jdstatic +\jdtype{\jdtypesimple{String}} +\JDpara{\jdtypesimple{Type}}{t}{Type-Object} +\JDtext{Returns the type (Array or Simple) of a type} +\JDsince{version 1.0 from 13.05.2008} +\JDauthor{Jolle} +\JDreturn{string with the corresponding texcommand} +\end{jdmethod} +\begin{jdmethod}{printLinks} +\jdprivate +\jdtype{\jdtypesimple{void}} +\JDpara{\jdtypesimple{Type}}{t}{Type-Object} +\JDtext{Writes the linked type} +\JDauthor{Jolle} +\JDsince{version 1.0 from 13.05.2008} +\end{jdmethod} +\begin{jdmethod}{printInhTable} +\jdprivate +\jdtype{\jdtypesimple{void}} +\JDpara{\jdtypesimple{InhTable}}{it}{the object with an (unsorted) table} +\JDtext{Writes the tableOfInheritance and all entries} +\JDsince{version 1.0 from 13.05.2008} +\JDauthor{Jolle} +\end{jdmethod} +\begin{jdmethod}{print} +\jdprivate +\jdtype{\jdtypesimple{void}} +\JDtext{Writes an linebreak} +\JDsince{version 1.0 from 13.05.2008} +\JDauthor{Jolle} +\end{jdmethod} +\begin{jdmethod}{printCommand} +\jdprivate +\jdtype{\jdtypesimple{void}} +\JDpara{\jdtypesimple{String}}{befehl}{name of the command} +\JDtext{Writes a tex-command} +\JDsince{version 1.0 from 13.05.2008} +\JDauthor{Jolle} +\end{jdmethod} +\begin{jdmethod}{printOpt} +\jdprivate +\jdtype{\jdtypesimple{void}} +\JDpara{\jdtypesimple{String}}{option}{option name} +\JDtext{Writes a tex-option} +\JDsince{version 1.0 from 13.05.2008} +\JDauthor{Jolle} +\end{jdmethod} +\begin{jdmethod}{printArgument} +\jdprivate +\jdtype{\jdtypesimple{void}} +\JDpara{\jdtypesimple{String}}{arg}{argumentname} +\JDtext{Writes a tex-argument} +\JDsince{version 1.0 from 13.05.2008} +\JDauthor{Jolle} +\end{jdmethod} +\begin{jdmethod}{printBegin} +\jdprivate +\jdtype{\jdtypesimple{void}} +\JDpara{\jdtypesimple{String}}{umgebung}{environmentname} +\JDtext{Writes the beginning of an environment} +\JDsince{version 1.0 from 13.05.2008} +\JDauthor{Jolle} +\end{jdmethod} +\begin{jdmethod}{printEnd} +\jdprivate +\jdtype{\jdtypesimple{void}} +\JDpara{\jdtypesimple{String}}{umgebung}{environmentname} +\JDtext{Writes the ending of an environment} +\JDsince{version 1.0 from 13.05.2008} +\JDauthor{Jolle} +\end{jdmethod} +\end{jdclass} |