vnfs/VES5.0/doxygen-1.8.12/html/examples/tclexample/html/namespacens.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>Tcl: ns Namespace 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">Tcl
  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="#nested-classes">Classes</a> &#124;
  42 <a href="#func-members">Functions</a>  </div>
  43   <div class="headertitle">
  44 <div class="title">ns Namespace Reference</div>  </div>
  45 </div><!--header-->
  46 <div class="contents">
  47
  48 <p>Documented namespace <code>ns</code> .
  49 <a href="#details">More...</a></p>
  50 <table class="memberdecls">
  51 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  52 Classes</h2></td></tr>
  53 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classns_1_1itcl__class.html">itcl_class</a></td></tr>
  54 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Documented itcl class <code><a class="el" href="classns_1_1itcl__class.html" title="Documented itcl class itcl_class . ">itcl_class</a></code> .  <a href="classns_1_1itcl__class.html#details">More...</a><br /></td></tr>
  55 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  56 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classns_1_1oo__class.html">oo_class</a></td></tr>
  57 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Documented oo class <code><a class="el" href="classns_1_1oo__class.html" title="Documented oo class oo_class . ">oo_class</a></code> .  <a href="classns_1_1oo__class.html#details">More...</a><br /></td></tr>
  58 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59 </table><table class="memberdecls">
  60 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  61 Functions</h2></td></tr>
  62 <tr class="memitem:a1429cbe84d32b17ea4783e5c5c00615b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacens.html#a1429cbe84d32b17ea4783e5c5c00615b">ns_proc</a> arg</td></tr>
  63 <tr class="memdesc:a1429cbe84d32b17ea4783e5c5c00615b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Documented proc <code>ns_proc</code> .  <a href="#a1429cbe84d32b17ea4783e5c5c00615b">More...</a><br /></td></tr>
  64 <tr class="separator:a1429cbe84d32b17ea4783e5c5c00615b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65 </table>
  66 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  67 <div class="textblock"><p>Documented namespace <code>ns</code> . </p>
  68 <p>The code is inserted here:</p>
  69 <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="keyword">namespace</span> <span class="keyword">eval</span> ns {</div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;  <span class="comment">## Documented proc \c ns_proc .</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"></span><span class="comment">  </span><span class="comment"># param[in] arg some argument</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"></span><span class="comment">  </span><span class="keyword">proc</span> ns_proc {arg} {}<span class="comment"></span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"></span>  <span class="comment">## Documented var \c ns_var .</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"></span><span class="comment">  </span><span class="comment"># Some documentation.</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"></span><span class="comment">  </span><span class="keyword">variable</span> ns_var<span class="comment"></span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"></span>  <span class="comment">## Documented itcl class \c itcl_class .</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"></span><span class="comment">  </span><span class="keyword">itcl::class</span> itcl_class {</div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;    <span class="comment">## Create object.</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"></span><span class="comment">    </span><span class="keyword">constructor</span> {args} {<span class="keyword">eval</span> $args}<span class="comment"></span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"></span>    <span class="comment">## Destroy object.</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"></span><span class="comment">    </span><span class="keyword">destructor</span> {<span class="keyword">exit</span>}<span class="comment"></span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"></span>    <span class="comment">## Documented itcl method \c itcl_method_x .</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"></span><span class="comment">    </span><span class="comment"># param[in] arg Argument</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"></span><span class="comment">    </span><span class="keyword">private</span> <span class="keyword">method</span> itcl_method_x {arg}{}<span class="comment"></span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"></span>    <span class="comment">## Documented itcl method \c itcl_method_y .</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"></span><span class="comment">    </span><span class="comment"># param[in] arg Argument</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"></span><span class="comment">    </span><span class="keyword">protected</span> <span class="keyword">method</span> itcl_method_y {arg} {}<span class="comment"></span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"></span>    <span class="comment">## Documented itcl method \c itcl_method_z .</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"></span><span class="comment">    </span><span class="comment"># param[in] arg Argument</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"></span><span class="comment">    </span><span class="keyword">public</span> <span class="keyword">method</span> itcl_method_z {arg} {}<span class="comment"></span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment"></span>    <span class="comment">## Documented common itcl var \c itcl_Var .</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment"></span><span class="comment">    </span><span class="keyword">common</span> itcl_Var<span class="comment"></span></div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"></span>    <span class="comment">## \protectedsection</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment"></span><span class="comment">    </span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;    <span class="keyword">variable</span> itcl_var1<span class="comment">;#&lt; Documented itcl var \c itcl_var1 .</span></div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment">    </span><span class="keyword">variable</span> itcl_var2}<span class="comment"></span></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment"></span>  <span class="comment">## Documented oo class \c oo_class .</span></div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment"></span><span class="comment">  </span><span class="keyword">oo::class</span> create oo_class {</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;    <span class="comment">## Create object.</span></div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="comment"></span><span class="comment">    </span><span class="comment"># Configure with args</span></div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="comment"></span><span class="comment">    </span><span class="keyword">constructor</span> {args} {<span class="keyword">eval</span> $args}<span class="comment"></span></div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="comment"></span>    <span class="comment">## Destroy object.</span></div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="comment"></span><span class="comment">    </span><span class="comment"># Exit.</span></div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="comment"></span><span class="comment">    </span><span class="keyword">destructor</span> {<span class="keyword">exit</span>}<span class="comment"></span></div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="comment"></span>    <span class="comment">## Documented oo var \c oo_var .</span></div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="comment"></span><span class="comment">    </span><span class="comment"># Defined inside class</span></div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="comment"></span><span class="comment">    </span><span class="keyword">variable</span> oo_var<span class="comment"></span></div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="comment"></span>    <span class="comment">## \private Documented oo method \c oo_method_x .</span></div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="comment"></span><span class="comment">    </span><span class="comment"># param[in] arg Argument</span></div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="comment"></span><span class="comment">    </span><span class="keyword">method</span> oo_method_x {arg} {}<span class="comment"></span></div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="comment"></span>    <span class="comment">## \protected Documented oo method \c oo_method_y .</span></div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="comment"></span><span class="comment">    </span><span class="comment"># param[in] arg Argument</span></div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment"></span><span class="comment">    </span><span class="keyword">method</span> oo_method_y {arg} {}<span class="comment"></span></div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="comment"></span>    <span class="comment">## \public Documented oo method \c oo_method_z .</span></div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="comment"></span><span class="comment">    </span><span class="comment"># param[in] arg Argument</span></div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="comment"></span><span class="comment">    </span><span class="keyword">method</span> oo_method_z {arg} {}<span class="comment"></span></div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="comment"></span>  }<span class="comment"></span></div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="comment"></span>}</div></div><!-- fragment --> </div><h2 class="groupheader">Function Documentation</h2>
  70 <a id="a1429cbe84d32b17ea4783e5c5c00615b"></a>
  71 <h2 class="memtitle"><span class="permalink"><a href="#a1429cbe84d32b17ea4783e5c5c00615b">&sect;&nbsp;</a></span>ns_proc()</h2>
  72
  73 <div class="memitem">
  74 <div class="memproto">
  75       <table class="memname">
  76         <tr>
  77           <td class="memname">ns::ns_proc</td>
  78           <td></td>
  79           <td class="paramtype">&#160;</td>
  80           <td class="paramname">arg &#160;</td>
  81         </tr>
  82         <tr>
  83           <td></td>
  84           <td></td>
  85           <td></td><td></td>
  86         </tr>
  87       </table>
  88 </div><div class="memdoc">
  89
  90 <p>Documented proc <code>ns_proc</code> . </p>
  91 <p>param[in] arg some argument </p>
  92 <div class="fragment"><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;  <span class="keyword">proc</span> ns_proc {arg} {}</div></div><!-- fragment -->
  93 </div>
  94 </div>
  95 </div><!-- contents -->
  96 <!-- start footer part -->
  97 <hr class="footer"/><address class="footer"><small>
  98 Generated by &#160;<a href="http://www.doxygen.org/index.html">
  99 <img class="footer" src="doxygen.png" alt="doxygen"/>
 100 </a> 1.8.12
 101 </small></address>
 102 </body>
 103 </html>