vnfs/VES5.0/doxygen-1.8.12/html/examples/jdstyle/latex/class_javadoc___test.tex

   1 \hypertarget{class_javadoc___test}{}\subsection{Javadoc\+\_\+\+Test Class Reference}
   2 \label{class_javadoc___test}\index{Javadoc\+\_\+\+Test@{Javadoc\+\_\+\+Test}}
   3
   4
   5 A test class.
   6
   7
   8 \subsubsection*{Public Types}
   9 \begin{DoxyCompactItemize}
  10 \item
  11 enum \hyperlink{class_javadoc___test_ae37fd1cbf1af522674cbd33873b786a6}{T\+Enum} \{ \hyperlink{class_javadoc___test_ae37fd1cbf1af522674cbd33873b786a6a90f0d8d4f07a79342261fb1c191af72b}{T\+Val1},
  12 \hyperlink{class_javadoc___test_ae37fd1cbf1af522674cbd33873b786a6a5954e696a652f442d7255af4e0d35d61}{T\+Val2},
  13 \hyperlink{class_javadoc___test_ae37fd1cbf1af522674cbd33873b786a6ab4a4dc16e1050c9604cf5c46a51e5a8e}{T\+Val3}
  14  \}\begin{DoxyCompactList}\small\item\em An enum. \end{DoxyCompactList}
  15 \end{DoxyCompactItemize}
  16 \subsubsection*{Public Member Functions}
  17 \begin{DoxyCompactItemize}
  18 \item
  19 \hyperlink{class_javadoc___test_a17313327932ae97596b0a455ba8342cc}{Javadoc\+\_\+\+Test} ()
  20 \begin{DoxyCompactList}\small\item\em A constructor. \end{DoxyCompactList}\item
  21 \hyperlink{class_javadoc___test_a60016cd15a4ed82bbc35be79a0a6a6b5}{$\sim$\+Javadoc\+\_\+\+Test} ()
  22 \begin{DoxyCompactList}\small\item\em A destructor. \end{DoxyCompactList}\item
  23 int \hyperlink{class_javadoc___test_a0c472683ed25ff096e8a9edfb18d550c}{test\+Me} (int a, const char $\ast$s)
  24 \begin{DoxyCompactList}\small\item\em a normal member taking two arguments and returning an integer value. \end{DoxyCompactList}\item
  25 virtual void \hyperlink{class_javadoc___test_ac2b39cabbe80957ae3e8bc2bd4e887f6}{test\+Me\+Too} (char c1, char c2)=0
  26 \begin{DoxyCompactList}\small\item\em A pure virtual member. \end{DoxyCompactList}\end{DoxyCompactItemize}
  27 \subsubsection*{Public Attributes}
  28 \begin{DoxyCompactItemize}
  29 \item
  30 enum \hyperlink{class_javadoc___test_ae37fd1cbf1af522674cbd33873b786a6}{Javadoc\+\_\+\+Test\+::\+T\+Enum} $\ast$ \hyperlink{class_javadoc___test_abcb36df9d8af3e69290c239ba483d6df}{enum\+Ptr}
  31 \begin{DoxyCompactList}\small\item\em enum pointer. \end{DoxyCompactList}\item
  32 enum \hyperlink{class_javadoc___test_ae37fd1cbf1af522674cbd33873b786a6}{Javadoc\+\_\+\+Test\+::\+T\+Enum} \hyperlink{class_javadoc___test_a689558649150237b53a5c8ed89c996c2}{enum\+Var}
  33 \begin{DoxyCompactList}\small\item\em enum variable. \end{DoxyCompactList}\item
  34 int \hyperlink{class_javadoc___test_a44a516fbc3a4865e2dcae34649c9df6a}{public\+Var}
  35 \begin{DoxyCompactList}\small\item\em a public variable. \end{DoxyCompactList}\item
  36 int($\ast$ \hyperlink{class_javadoc___test_ace81a523a4eef44501a841a6d338832b}{handler} )(int a, int b)
  37 \begin{DoxyCompactList}\small\item\em a function variable. \end{DoxyCompactList}\end{DoxyCompactItemize}
  38
  39
  40 \subsubsection{Detailed Description}
  41 A test class.
  42
  43 A more elaborate class description.
  44
  45 \subsubsection{Member Enumeration Documentation}
  46 \hypertarget{class_javadoc___test_ae37fd1cbf1af522674cbd33873b786a6}{}\label{class_javadoc___test_ae37fd1cbf1af522674cbd33873b786a6}
  47 \index{Javadoc\+\_\+\+Test@{Javadoc\+\_\+\+Test}!T\+Enum@{T\+Enum}}
  48 \index{T\+Enum@{T\+Enum}!Javadoc\+\_\+\+Test@{Javadoc\+\_\+\+Test}}
  49 \paragraph{\texorpdfstring{T\+Enum}{TEnum}}
  50 {\footnotesize\ttfamily enum \hyperlink{class_javadoc___test_ae37fd1cbf1af522674cbd33873b786a6}{Javadoc\+\_\+\+Test\+::\+T\+Enum}}
  51
  52
  53
  54 An enum.
  55
  56 More detailed enum description. \begin{DoxyEnumFields}{Enumerator}
  57 \raisebox{\heightof{T}}[0pt][0pt]{\index{T\+Val1@{T\+Val1}!Javadoc\+\_\+\+Test@{Javadoc\+\_\+\+Test}}\index{Javadoc\+\_\+\+Test@{Javadoc\+\_\+\+Test}!T\+Val1@{T\+Val1}}}\hypertarget{class_javadoc___test_ae37fd1cbf1af522674cbd33873b786a6a90f0d8d4f07a79342261fb1c191af72b}{}\label{class_javadoc___test_ae37fd1cbf1af522674cbd33873b786a6a90f0d8d4f07a79342261fb1c191af72b}
  58 T\+Val1&enum value T\+Val1. \\
  59 \hline
  60
  61 \raisebox{\heightof{T}}[0pt][0pt]{\index{T\+Val2@{T\+Val2}!Javadoc\+\_\+\+Test@{Javadoc\+\_\+\+Test}}\index{Javadoc\+\_\+\+Test@{Javadoc\+\_\+\+Test}!T\+Val2@{T\+Val2}}}\hypertarget{class_javadoc___test_ae37fd1cbf1af522674cbd33873b786a6a5954e696a652f442d7255af4e0d35d61}{}\label{class_javadoc___test_ae37fd1cbf1af522674cbd33873b786a6a5954e696a652f442d7255af4e0d35d61}
  62 T\+Val2&enum value T\+Val2. \\
  63 \hline
  64
  65 \raisebox{\heightof{T}}[0pt][0pt]{\index{T\+Val3@{T\+Val3}!Javadoc\+\_\+\+Test@{Javadoc\+\_\+\+Test}}\index{Javadoc\+\_\+\+Test@{Javadoc\+\_\+\+Test}!T\+Val3@{T\+Val3}}}\hypertarget{class_javadoc___test_ae37fd1cbf1af522674cbd33873b786a6ab4a4dc16e1050c9604cf5c46a51e5a8e}{}\label{class_javadoc___test_ae37fd1cbf1af522674cbd33873b786a6ab4a4dc16e1050c9604cf5c46a51e5a8e}
  66 T\+Val3&enum value T\+Val3. \\
  67 \hline
  68
  69 \end{DoxyEnumFields}
  70
  71
  72 \subsubsection{Constructor \& Destructor Documentation}
  73 \hypertarget{class_javadoc___test_a17313327932ae97596b0a455ba8342cc}{}\label{class_javadoc___test_a17313327932ae97596b0a455ba8342cc}
  74 \index{Javadoc\+\_\+\+Test@{Javadoc\+\_\+\+Test}!Javadoc\+\_\+\+Test@{Javadoc\+\_\+\+Test}}
  75 \index{Javadoc\+\_\+\+Test@{Javadoc\+\_\+\+Test}!Javadoc\+\_\+\+Test@{Javadoc\+\_\+\+Test}}
  76 \paragraph{\texorpdfstring{Javadoc\+\_\+\+Test()}{Javadoc\_Test()}}
  77 {\footnotesize\ttfamily Javadoc\+\_\+\+Test\+::\+Javadoc\+\_\+\+Test (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
  78
  79
  80
  81 A constructor.
  82
  83 A more elaborate description of the constructor. \hypertarget{class_javadoc___test_a60016cd15a4ed82bbc35be79a0a6a6b5}{}\label{class_javadoc___test_a60016cd15a4ed82bbc35be79a0a6a6b5}
  84 \index{Javadoc\+\_\+\+Test@{Javadoc\+\_\+\+Test}!````~Javadoc\+\_\+\+Test@{$\sim$\+Javadoc\+\_\+\+Test}}
  85 \index{````~Javadoc\+\_\+\+Test@{$\sim$\+Javadoc\+\_\+\+Test}!Javadoc\+\_\+\+Test@{Javadoc\+\_\+\+Test}}
  86 \paragraph{\texorpdfstring{$\sim$\+Javadoc\+\_\+\+Test()}{~Javadoc\_Test()}}
  87 {\footnotesize\ttfamily Javadoc\+\_\+\+Test\+::$\sim$\+Javadoc\+\_\+\+Test (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
  88
  89
  90
  91 A destructor.
  92
  93 A more elaborate description of the destructor.
  94
  95 \subsubsection{Member Function Documentation}
  96 \hypertarget{class_javadoc___test_a0c472683ed25ff096e8a9edfb18d550c}{}\label{class_javadoc___test_a0c472683ed25ff096e8a9edfb18d550c}
  97 \index{Javadoc\+\_\+\+Test@{Javadoc\+\_\+\+Test}!test\+Me@{test\+Me}}
  98 \index{test\+Me@{test\+Me}!Javadoc\+\_\+\+Test@{Javadoc\+\_\+\+Test}}
  99 \paragraph{\texorpdfstring{test\+Me()}{testMe()}}
 100 {\footnotesize\ttfamily int Javadoc\+\_\+\+Test\+::test\+Me (\begin{DoxyParamCaption}\item[{int}]{a,  }\item[{const char $\ast$}]{s }\end{DoxyParamCaption})}
 101
 102
 103
 104 a normal member taking two arguments and returning an integer value.
 105
 106
 107 \begin{DoxyParams}{Parameters}
 108 {\em a} & an integer argument. \\
 109 \hline
 110 {\em s} & a constant character pointer. \\
 111 \hline
 112 \end{DoxyParams}
 113 \begin{DoxySeeAlso}{See also}
 114 \hyperlink{class_javadoc___test_a17313327932ae97596b0a455ba8342cc}{Javadoc\+\_\+\+Test()}
 115
 116 \hyperlink{class_javadoc___test_a60016cd15a4ed82bbc35be79a0a6a6b5}{$\sim$\+Javadoc\+\_\+\+Test()}
 117
 118 \hyperlink{class_javadoc___test_ac2b39cabbe80957ae3e8bc2bd4e887f6}{test\+Me\+Too()}
 119
 120 \hyperlink{class_javadoc___test_a44a516fbc3a4865e2dcae34649c9df6a}{public\+Var()}
 121 \end{DoxySeeAlso}
 122 \begin{DoxyReturn}{Returns}
 123 The test results
 124 \end{DoxyReturn}
 125 \hypertarget{class_javadoc___test_ac2b39cabbe80957ae3e8bc2bd4e887f6}{}\label{class_javadoc___test_ac2b39cabbe80957ae3e8bc2bd4e887f6}
 126 \index{Javadoc\+\_\+\+Test@{Javadoc\+\_\+\+Test}!test\+Me\+Too@{test\+Me\+Too}}
 127 \index{test\+Me\+Too@{test\+Me\+Too}!Javadoc\+\_\+\+Test@{Javadoc\+\_\+\+Test}}
 128 \paragraph{\texorpdfstring{test\+Me\+Too()}{testMeToo()}}
 129 {\footnotesize\ttfamily virtual void Javadoc\+\_\+\+Test\+::test\+Me\+Too (\begin{DoxyParamCaption}\item[{char}]{c1,  }\item[{char}]{c2 }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}
 130
 131
 132
 133 A pure virtual member.
 134
 135 \begin{DoxySeeAlso}{See also}
 136 \hyperlink{class_javadoc___test_a0c472683ed25ff096e8a9edfb18d550c}{test\+Me()}
 137 \end{DoxySeeAlso}
 138
 139 \begin{DoxyParams}{Parameters}
 140 {\em c1} & the first argument. \\
 141 \hline
 142 {\em c2} & the second argument. \\
 143 \hline
 144 \end{DoxyParams}
 145
 146
 147 \subsubsection{Member Data Documentation}
 148 \hypertarget{class_javadoc___test_abcb36df9d8af3e69290c239ba483d6df}{}\label{class_javadoc___test_abcb36df9d8af3e69290c239ba483d6df}
 149 \index{Javadoc\+\_\+\+Test@{Javadoc\+\_\+\+Test}!enum\+Ptr@{enum\+Ptr}}
 150 \index{enum\+Ptr@{enum\+Ptr}!Javadoc\+\_\+\+Test@{Javadoc\+\_\+\+Test}}
 151 \paragraph{\texorpdfstring{enum\+Ptr}{enumPtr}}
 152 {\footnotesize\ttfamily enum \hyperlink{class_javadoc___test_ae37fd1cbf1af522674cbd33873b786a6}{Javadoc\+\_\+\+Test\+::\+T\+Enum}
 153        $\ast$ Javadoc\+\_\+\+Test\+::enum\+Ptr}
 154
 155
 156
 157 enum pointer.
 158
 159 Details. \hypertarget{class_javadoc___test_a689558649150237b53a5c8ed89c996c2}{}\label{class_javadoc___test_a689558649150237b53a5c8ed89c996c2}
 160 \index{Javadoc\+\_\+\+Test@{Javadoc\+\_\+\+Test}!enum\+Var@{enum\+Var}}
 161 \index{enum\+Var@{enum\+Var}!Javadoc\+\_\+\+Test@{Javadoc\+\_\+\+Test}}
 162 \paragraph{\texorpdfstring{enum\+Var}{enumVar}}
 163 {\footnotesize\ttfamily enum \hyperlink{class_javadoc___test_ae37fd1cbf1af522674cbd33873b786a6}{Javadoc\+\_\+\+Test\+::\+T\+Enum}
 164         Javadoc\+\_\+\+Test\+::enum\+Var}
 165
 166
 167
 168 enum variable.
 169
 170 Details. \hypertarget{class_javadoc___test_ace81a523a4eef44501a841a6d338832b}{}\label{class_javadoc___test_ace81a523a4eef44501a841a6d338832b}
 171 \index{Javadoc\+\_\+\+Test@{Javadoc\+\_\+\+Test}!handler@{handler}}
 172 \index{handler@{handler}!Javadoc\+\_\+\+Test@{Javadoc\+\_\+\+Test}}
 173 \paragraph{\texorpdfstring{handler}{handler}}
 174 {\footnotesize\ttfamily int($\ast$ Javadoc\+\_\+\+Test\+::handler) (int a, int b)}
 175
 176
 177
 178 a function variable.
 179
 180 Details. \hypertarget{class_javadoc___test_a44a516fbc3a4865e2dcae34649c9df6a}{}\label{class_javadoc___test_a44a516fbc3a4865e2dcae34649c9df6a}
 181 \index{Javadoc\+\_\+\+Test@{Javadoc\+\_\+\+Test}!public\+Var@{public\+Var}}
 182 \index{public\+Var@{public\+Var}!Javadoc\+\_\+\+Test@{Javadoc\+\_\+\+Test}}
 183 \paragraph{\texorpdfstring{public\+Var}{publicVar}}
 184 {\footnotesize\ttfamily int Javadoc\+\_\+\+Test\+::public\+Var}
 185
 186
 187
 188 a public variable.
 189
 190 Details.
 191
 192 The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
 193 \item
 194 jdstyle.\+cpp\end{DoxyCompactItemize}