summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/javadoc/doclet/doc/TexGen.tex
blob: bad0577d8a86d5cbaade86e9f38a4ba223a55499 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
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}