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

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.12"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>JavaDoc Style: Javadoc_Test Class Reference</title>
   9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  13 </head>
  14 <body>
  15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16 <div id="titlearea">
  17 <table cellspacing="0" cellpadding="0">
  18  <tbody>
  19  <tr style="height: 56px;">
  20   <td id="projectalign" style="padding-left: 0.5em;">
  21    <div id="projectname">JavaDoc Style
  22    </div>
  23   </td>
  24  </tr>
  25  </tbody>
  26 </table>
  27 </div>
  28 <!-- end header part -->
  29 <!-- Generated by Doxygen 1.8.12 -->
  30 <script type="text/javascript" src="menudata.js"></script>
  31 <script type="text/javascript" src="menu.js"></script>
  32 <script type="text/javascript">
  33 $(function() {
  34   initMenu('',false,false,'search.php','Search');
  35 });
  36 </script>
  37 <div id="main-nav"></div>
  38 </div><!-- top -->
  39 <div class="header">
  40   <div class="summary">
  41 <a href="#pub-types">Public Types</a> &#124;
  42 <a href="#pub-methods">Public Member Functions</a> &#124;
  43 <a href="#pub-attribs">Public Attributes</a> &#124;
  44 <a href="class_javadoc___test-members.html">List of all members</a>  </div>
  45   <div class="headertitle">
  46 <div class="title">Javadoc_Test Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
  47 </div><!--header-->
  48 <div class="contents">
  49
  50 <p>A test class.
  51  <a href="class_javadoc___test.html#details">More...</a></p>
  52 <table class="memberdecls">
  53 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  54 Public Types</h2></td></tr>
  55 <tr class="memitem:ae37fd1cbf1af522674cbd33873b786a6"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_javadoc___test.html#ae37fd1cbf1af522674cbd33873b786a6">TEnum</a> { <a class="el" href="class_javadoc___test.html#ae37fd1cbf1af522674cbd33873b786a6a90f0d8d4f07a79342261fb1c191af72b">TVal1</a>,
  56 <a class="el" href="class_javadoc___test.html#ae37fd1cbf1af522674cbd33873b786a6a5954e696a652f442d7255af4e0d35d61">TVal2</a>,
  57 <a class="el" href="class_javadoc___test.html#ae37fd1cbf1af522674cbd33873b786a6ab4a4dc16e1050c9604cf5c46a51e5a8e">TVal3</a>
  58  }<tr class="memdesc:ae37fd1cbf1af522674cbd33873b786a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">An enum.  <a href="class_javadoc___test.html#ae37fd1cbf1af522674cbd33873b786a6">More...</a><br /></td></tr>
  59 </td></tr>
  60 <tr class="separator:ae37fd1cbf1af522674cbd33873b786a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61 </table><table class="memberdecls">
  62 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  63 Public Member Functions</h2></td></tr>
  64 <tr class="memitem:a17313327932ae97596b0a455ba8342cc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_javadoc___test.html#a17313327932ae97596b0a455ba8342cc">Javadoc_Test</a> ()</td></tr>
  65 <tr class="memdesc:a17313327932ae97596b0a455ba8342cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">A constructor.  <a href="#a17313327932ae97596b0a455ba8342cc">More...</a><br /></td></tr>
  66 <tr class="separator:a17313327932ae97596b0a455ba8342cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67 <tr class="memitem:a60016cd15a4ed82bbc35be79a0a6a6b5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_javadoc___test.html#a60016cd15a4ed82bbc35be79a0a6a6b5">~Javadoc_Test</a> ()</td></tr>
  68 <tr class="memdesc:a60016cd15a4ed82bbc35be79a0a6a6b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">A destructor.  <a href="#a60016cd15a4ed82bbc35be79a0a6a6b5">More...</a><br /></td></tr>
  69 <tr class="separator:a60016cd15a4ed82bbc35be79a0a6a6b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70 <tr class="memitem:a0c472683ed25ff096e8a9edfb18d550c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_javadoc___test.html#a0c472683ed25ff096e8a9edfb18d550c">testMe</a> (int a, const char *s)</td></tr>
  71 <tr class="memdesc:a0c472683ed25ff096e8a9edfb18d550c"><td class="mdescLeft">&#160;</td><td class="mdescRight">a normal member taking two arguments and returning an integer value.  <a href="#a0c472683ed25ff096e8a9edfb18d550c">More...</a><br /></td></tr>
  72 <tr class="separator:a0c472683ed25ff096e8a9edfb18d550c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73 <tr class="memitem:ac2b39cabbe80957ae3e8bc2bd4e887f6"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_javadoc___test.html#ac2b39cabbe80957ae3e8bc2bd4e887f6">testMeToo</a> (char c1, char c2)=0</td></tr>
  74 <tr class="memdesc:ac2b39cabbe80957ae3e8bc2bd4e887f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">A pure virtual member.  <a href="#ac2b39cabbe80957ae3e8bc2bd4e887f6">More...</a><br /></td></tr>
  75 <tr class="separator:ac2b39cabbe80957ae3e8bc2bd4e887f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76 </table><table class="memberdecls">
  77 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  78 Public Attributes</h2></td></tr>
  79 <tr class="memitem:abcb36df9d8af3e69290c239ba483d6df"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="class_javadoc___test.html#ae37fd1cbf1af522674cbd33873b786a6">Javadoc_Test::TEnum</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_javadoc___test.html#abcb36df9d8af3e69290c239ba483d6df">enumPtr</a></td></tr>
  80 <tr class="memdesc:abcb36df9d8af3e69290c239ba483d6df"><td class="mdescLeft">&#160;</td><td class="mdescRight">enum pointer.  <a href="#abcb36df9d8af3e69290c239ba483d6df">More...</a><br /></td></tr>
  81 <tr class="separator:abcb36df9d8af3e69290c239ba483d6df"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82 <tr class="memitem:a689558649150237b53a5c8ed89c996c2"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="class_javadoc___test.html#ae37fd1cbf1af522674cbd33873b786a6">Javadoc_Test::TEnum</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_javadoc___test.html#a689558649150237b53a5c8ed89c996c2">enumVar</a></td></tr>
  83 <tr class="memdesc:a689558649150237b53a5c8ed89c996c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">enum variable.  <a href="#a689558649150237b53a5c8ed89c996c2">More...</a><br /></td></tr>
  84 <tr class="separator:a689558649150237b53a5c8ed89c996c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85 <tr class="memitem:a44a516fbc3a4865e2dcae34649c9df6a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_javadoc___test.html#a44a516fbc3a4865e2dcae34649c9df6a">publicVar</a></td></tr>
  86 <tr class="memdesc:a44a516fbc3a4865e2dcae34649c9df6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">a public variable.  <a href="#a44a516fbc3a4865e2dcae34649c9df6a">More...</a><br /></td></tr>
  87 <tr class="separator:a44a516fbc3a4865e2dcae34649c9df6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88 <tr class="memitem:ace81a523a4eef44501a841a6d338832b"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_javadoc___test.html#ace81a523a4eef44501a841a6d338832b">handler</a> )(int a, int b)</td></tr>
  89 <tr class="memdesc:ace81a523a4eef44501a841a6d338832b"><td class="mdescLeft">&#160;</td><td class="mdescRight">a function variable.  <a href="#ace81a523a4eef44501a841a6d338832b">More...</a><br /></td></tr>
  90 <tr class="separator:ace81a523a4eef44501a841a6d338832b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91 </table>
  92 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  93 <div class="textblock"><p>A test class. </p>
  94 <p>A more elaborate class description. </p>
  95 </div><h2 class="groupheader">Member Enumeration Documentation</h2>
  96 <a id="ae37fd1cbf1af522674cbd33873b786a6"></a>
  97 <h2 class="memtitle"><span class="permalink"><a href="#ae37fd1cbf1af522674cbd33873b786a6">&sect;&nbsp;</a></span>TEnum</h2>
  98
  99 <div class="memitem">
 100 <div class="memproto">
 101       <table class="memname">
 102         <tr>
 103           <td class="memname">enum <a class="el" href="class_javadoc___test.html#ae37fd1cbf1af522674cbd33873b786a6">Javadoc_Test::TEnum</a></td>
 104         </tr>
 105       </table>
 106 </div><div class="memdoc">
 107
 108 <p>An enum. </p>
 109 <p>More detailed enum description. </p>
 110 <table class="fieldtable">
 111 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ae37fd1cbf1af522674cbd33873b786a6a90f0d8d4f07a79342261fb1c191af72b"></a>TVal1&#160;</td><td class="fielddoc"><p>enum value TVal1. </p>
 112 </td></tr>
 113 <tr><td class="fieldname"><a id="ae37fd1cbf1af522674cbd33873b786a6a5954e696a652f442d7255af4e0d35d61"></a>TVal2&#160;</td><td class="fielddoc"><p>enum value TVal2. </p>
 114 </td></tr>
 115 <tr><td class="fieldname"><a id="ae37fd1cbf1af522674cbd33873b786a6ab4a4dc16e1050c9604cf5c46a51e5a8e"></a>TVal3&#160;</td><td class="fielddoc"><p>enum value TVal3. </p>
 116 </td></tr>
 117 </table>
 118
 119 </div>
 120 </div>
 121 <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 122 <a id="a17313327932ae97596b0a455ba8342cc"></a>
 123 <h2 class="memtitle"><span class="permalink"><a href="#a17313327932ae97596b0a455ba8342cc">&sect;&nbsp;</a></span>Javadoc_Test()</h2>
 124
 125 <div class="memitem">
 126 <div class="memproto">
 127       <table class="memname">
 128         <tr>
 129           <td class="memname">Javadoc_Test::Javadoc_Test </td>
 130           <td>(</td>
 131           <td class="paramname"></td><td>)</td>
 132           <td></td>
 133         </tr>
 134       </table>
 135 </div><div class="memdoc">
 136
 137 <p>A constructor. </p>
 138 <p>A more elaborate description of the constructor. </p>
 139
 140 </div>
 141 </div>
 142 <a id="a60016cd15a4ed82bbc35be79a0a6a6b5"></a>
 143 <h2 class="memtitle"><span class="permalink"><a href="#a60016cd15a4ed82bbc35be79a0a6a6b5">&sect;&nbsp;</a></span>~Javadoc_Test()</h2>
 144
 145 <div class="memitem">
 146 <div class="memproto">
 147       <table class="memname">
 148         <tr>
 149           <td class="memname">Javadoc_Test::~Javadoc_Test </td>
 150           <td>(</td>
 151           <td class="paramname"></td><td>)</td>
 152           <td></td>
 153         </tr>
 154       </table>
 155 </div><div class="memdoc">
 156
 157 <p>A destructor. </p>
 158 <p>A more elaborate description of the destructor. </p>
 159
 160 </div>
 161 </div>
 162 <h2 class="groupheader">Member Function Documentation</h2>
 163 <a id="a0c472683ed25ff096e8a9edfb18d550c"></a>
 164 <h2 class="memtitle"><span class="permalink"><a href="#a0c472683ed25ff096e8a9edfb18d550c">&sect;&nbsp;</a></span>testMe()</h2>
 165
 166 <div class="memitem">
 167 <div class="memproto">
 168       <table class="memname">
 169         <tr>
 170           <td class="memname">int Javadoc_Test::testMe </td>
 171           <td>(</td>
 172           <td class="paramtype">int&#160;</td>
 173           <td class="paramname"><em>a</em>, </td>
 174         </tr>
 175         <tr>
 176           <td class="paramkey"></td>
 177           <td></td>
 178           <td class="paramtype">const char *&#160;</td>
 179           <td class="paramname"><em>s</em>&#160;</td>
 180         </tr>
 181         <tr>
 182           <td></td>
 183           <td>)</td>
 184           <td></td><td></td>
 185         </tr>
 186       </table>
 187 </div><div class="memdoc">
 188
 189 <p>a normal member taking two arguments and returning an integer value. </p>
 190 <dl class="params"><dt>Parameters</dt><dd>
 191   <table class="params">
 192     <tr><td class="paramname">a</td><td>an integer argument. </td></tr>
 193     <tr><td class="paramname">s</td><td>a constant character pointer. </td></tr>
 194   </table>
 195   </dd>
 196 </dl>
 197 <dl class="section see"><dt>See also</dt><dd><a class="el" href="class_javadoc___test.html#a17313327932ae97596b0a455ba8342cc" title="A constructor. ">Javadoc_Test()</a> </dd>
 198 <dd>
 199 <a class="el" href="class_javadoc___test.html#a60016cd15a4ed82bbc35be79a0a6a6b5" title="A destructor. ">~Javadoc_Test()</a> </dd>
 200 <dd>
 201 <a class="el" href="class_javadoc___test.html#ac2b39cabbe80957ae3e8bc2bd4e887f6" title="A pure virtual member. ">testMeToo()</a> </dd>
 202 <dd>
 203 <a class="el" href="class_javadoc___test.html#a44a516fbc3a4865e2dcae34649c9df6a" title="a public variable. ">publicVar()</a> </dd></dl>
 204 <dl class="section return"><dt>Returns</dt><dd>The test results </dd></dl>
 205
 206 </div>
 207 </div>
 208 <a id="ac2b39cabbe80957ae3e8bc2bd4e887f6"></a>
 209 <h2 class="memtitle"><span class="permalink"><a href="#ac2b39cabbe80957ae3e8bc2bd4e887f6">&sect;&nbsp;</a></span>testMeToo()</h2>
 210
 211 <div class="memitem">
 212 <div class="memproto">
 213 <table class="mlabels">
 214   <tr>
 215   <td class="mlabels-left">
 216       <table class="memname">
 217         <tr>
 218           <td class="memname">virtual void Javadoc_Test::testMeToo </td>
 219           <td>(</td>
 220           <td class="paramtype">char&#160;</td>
 221           <td class="paramname"><em>c1</em>, </td>
 222         </tr>
 223         <tr>
 224           <td class="paramkey"></td>
 225           <td></td>
 226           <td class="paramtype">char&#160;</td>
 227           <td class="paramname"><em>c2</em>&#160;</td>
 228         </tr>
 229         <tr>
 230           <td></td>
 231           <td>)</td>
 232           <td></td><td></td>
 233         </tr>
 234       </table>
 235   </td>
 236   <td class="mlabels-right">
 237 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 238   </tr>
 239 </table>
 240 </div><div class="memdoc">
 241
 242 <p>A pure virtual member. </p>
 243 <dl class="section see"><dt>See also</dt><dd><a class="el" href="class_javadoc___test.html#a0c472683ed25ff096e8a9edfb18d550c" title="a normal member taking two arguments and returning an integer value. ">testMe()</a> </dd></dl>
 244 <dl class="params"><dt>Parameters</dt><dd>
 245   <table class="params">
 246     <tr><td class="paramname">c1</td><td>the first argument. </td></tr>
 247     <tr><td class="paramname">c2</td><td>the second argument. </td></tr>
 248   </table>
 249   </dd>
 250 </dl>
 251
 252 </div>
 253 </div>
 254 <h2 class="groupheader">Member Data Documentation</h2>
 255 <a id="abcb36df9d8af3e69290c239ba483d6df"></a>
 256 <h2 class="memtitle"><span class="permalink"><a href="#abcb36df9d8af3e69290c239ba483d6df">&sect;&nbsp;</a></span>enumPtr</h2>
 257
 258 <div class="memitem">
 259 <div class="memproto">
 260       <table class="memname">
 261         <tr>
 262           <td class="memname">enum <a class="el" href="class_javadoc___test.html#ae37fd1cbf1af522674cbd33873b786a6">Javadoc_Test::TEnum</a>
 263        * Javadoc_Test::enumPtr</td>
 264         </tr>
 265       </table>
 266 </div><div class="memdoc">
 267
 268 <p>enum pointer. </p>
 269 <p>Details. </p>
 270
 271 </div>
 272 </div>
 273 <a id="a689558649150237b53a5c8ed89c996c2"></a>
 274 <h2 class="memtitle"><span class="permalink"><a href="#a689558649150237b53a5c8ed89c996c2">&sect;&nbsp;</a></span>enumVar</h2>
 275
 276 <div class="memitem">
 277 <div class="memproto">
 278       <table class="memname">
 279         <tr>
 280           <td class="memname">enum <a class="el" href="class_javadoc___test.html#ae37fd1cbf1af522674cbd33873b786a6">Javadoc_Test::TEnum</a>
 281         Javadoc_Test::enumVar</td>
 282         </tr>
 283       </table>
 284 </div><div class="memdoc">
 285
 286 <p>enum variable. </p>
 287 <p>Details. </p>
 288
 289 </div>
 290 </div>
 291 <a id="ace81a523a4eef44501a841a6d338832b"></a>
 292 <h2 class="memtitle"><span class="permalink"><a href="#ace81a523a4eef44501a841a6d338832b">&sect;&nbsp;</a></span>handler</h2>
 293
 294 <div class="memitem">
 295 <div class="memproto">
 296       <table class="memname">
 297         <tr>
 298           <td class="memname">int(* Javadoc_Test::handler) (int a, int b)</td>
 299         </tr>
 300       </table>
 301 </div><div class="memdoc">
 302
 303 <p>a function variable. </p>
 304 <p>Details. </p>
 305
 306 </div>
 307 </div>
 308 <a id="a44a516fbc3a4865e2dcae34649c9df6a"></a>
 309 <h2 class="memtitle"><span class="permalink"><a href="#a44a516fbc3a4865e2dcae34649c9df6a">&sect;&nbsp;</a></span>publicVar</h2>
 310
 311 <div class="memitem">
 312 <div class="memproto">
 313       <table class="memname">
 314         <tr>
 315           <td class="memname">int Javadoc_Test::publicVar</td>
 316         </tr>
 317       </table>
 318 </div><div class="memdoc">
 319
 320 <p>a public variable. </p>
 321 <p>Details. </p>
 322
 323 </div>
 324 </div>
 325 <hr/>The documentation for this class was generated from the following file:<ul>
 326 <li>jdstyle.cpp</li>
 327 </ul>
 328 </div><!-- contents -->
 329 <!-- start footer part -->
 330 <hr class="footer"/><address class="footer"><small>
 331 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 332 <img class="footer" src="doxygen.png" alt="doxygen"/>
 333 </a> 1.8.12
 334 </small></address>
 335 </body>
 336 </html>