diff options
Diffstat (limited to 'macros/latex/contrib/javadoc/doclet/doc/TexGen.tex')
-rw-r--r-- | macros/latex/contrib/javadoc/doclet/doc/TexGen.tex | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/macros/latex/contrib/javadoc/doclet/doc/TexGen.tex b/macros/latex/contrib/javadoc/doclet/doc/TexGen.tex new file mode 100644 index 0000000000..bad0577d8a --- /dev/null +++ b/macros/latex/contrib/javadoc/doclet/doc/TexGen.tex @@ -0,0 +1,71 @@ +\begin{jdclass}[class]{TexGen} +\begin{jdclassheader} + +\jdpublic +\jdinherits{\jdtypesimple{Object}\jdinh \jdtypesimple{Doclet}} +\JDtext{The Doclet writes the javadoc-content into Tex-files referring to the javadoc-Package. + + Mandatory CommandLineOption is: -dest destinationpath for the outputfile(s)} +\JDauthor{Jolle} +\JDsince{13.05.2008} +\JDversion{1.0} +\end{jdclassheader} +\begin{jdinheritancetable} \jdInhEntry{\jdtypesimple{LanguageVersion} languageVersion( )}{Doclet} + \jdInhEntry{\jdtypesimple{int} optionLength( \jdtypesimple{String} )}{Doclet} + \jdInhEntry{\jdtypesimple{boolean} start( \jdtypesimple{RootDoc} )}{Doclet} + \jdInhEntry{\jdtypesimple{boolean} validOptions( \jdtypearray{String}{\lbrack{}\rbrack{}\lbrack{}\rbrack{}}, \jdtypesimple{DocErrorReporter} )}{Doclet} + \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}{destpath} +\jdprivate \jdstatic +\jdtype{\jdtypesimple{String}} +\JDtext{In this variable the destinationpath is storaged + + The variable is set during validation of the commandlineparameter and read to write + the output files} +\JDauthor{Jolle} +\JDsince{version 1.0 from 13.05.2008} +\end{jdfield} +\begin{jdconstructor} +\jdpublic +\end{jdconstructor} +\begin{jdmethod}{start} +\jdpublic \jdstatic +\jdtype{\jdtypesimple{boolean}} +\JDpara{\jdtypesimple{RootDoc}}{root}{the parsed element with ALL information} +\JDtext{method that is called from the javadoc-programm after parsing the inputfiles} +\JDauthor{Jolle} +\JDreturn{true, if process successful; false if not} +\JDsince{version 1.0 from 13.05.2008} +\end{jdmethod} +\begin{jdmethod}{optionLength} +\jdpublic \jdstatic +\jdtype{\jdtypesimple{int}} +\JDpara{\jdtypesimple{String}}{option}{optionname (starting with "-")} +\JDtext{Method, with number of arguments to an commandlineparameter. + Returns 2 for -dest} +\JDauthor{Jolle} +\JDreturn{0, if option doesn't exist, otherwise a value > 1} +\JDsince{version 1.0 from 13.05.2008} +\end{jdmethod} +\begin{jdmethod}{validOptions} +\jdpublic \jdstatic +\jdtype{\jdtypesimple{boolean}} +\JDpara{\jdtypearray{String}{\lbrack{}\rbrack{}\lbrack{}\rbrack{}}}{options}{array with all options and their arguments} +\JDpara{\jdtypesimple{DocErrorReporter}}{reporter}{an object to report the process} +\JDtext{Method validating the commandline call.} +\JDauthor{Jolle} +\JDreturn{validation result} +\JDsince{version 1.0 from 13.05.2008} +\end{jdmethod} +\end{jdclass} |