vnfs/VES5.0/doxygen-1.8.12/html/examples/tclexample/latex/namespacens.tex

   1 \hypertarget{namespacens}{}\subsection{ns Namespace Reference}
   2 \label{namespacens}\index{ns@{ns}}
   3
   4
   5 Documented namespace {\ttfamily ns} .
   6
   7
   8 \subsubsection*{Classes}
   9 \begin{DoxyCompactItemize}
  10 \item
  11 class \hyperlink{classns_1_1itcl__class}{itcl\+\_\+class}
  12 \begin{DoxyCompactList}\small\item\em Documented itcl class {\ttfamily \hyperlink{classns_1_1itcl__class}{itcl\+\_\+class}} . \end{DoxyCompactList}\item
  13 class \hyperlink{classns_1_1oo__class}{oo\+\_\+class}
  14 \begin{DoxyCompactList}\small\item\em Documented oo class {\ttfamily \hyperlink{classns_1_1oo__class}{oo\+\_\+class}} . \end{DoxyCompactList}\end{DoxyCompactItemize}
  15 \subsubsection*{Functions}
  16 \begin{DoxyCompactItemize}
  17 \item
  18 \hyperlink{namespacens_a1429cbe84d32b17ea4783e5c5c00615b}{ns\+\_\+proc} arg
  19 \begin{DoxyCompactList}\small\item\em Documented proc {\ttfamily ns\+\_\+proc} . \end{DoxyCompactList}\end{DoxyCompactItemize}
  20
  21
  22 \subsubsection{Detailed Description}
  23 Documented namespace {\ttfamily ns} .
  24
  25 The code is inserted here\+:
  26
  27
  28 \begin{DoxyCode}
  29 1 \textcolor{keyword}{namespace} \textcolor{keyword}{eval} ns \{
  30 2   \textcolor{comment}{## Documented proc \(\backslash\)c ns\_proc .}
  31 3 \textcolor{comment}{}\textcolor{comment}{  }\textcolor{comment}{# param[in] arg some argument}
  32 4 \textcolor{comment}{}\textcolor{comment}{  }\textcolor{keyword}{proc} ns\_proc \{arg\} \{\}\textcolor{comment}{}
  33 5 \textcolor{comment}{}  \textcolor{comment}{## Documented var \(\backslash\)c ns\_var .}
  34 6 \textcolor{comment}{}\textcolor{comment}{  }\textcolor{comment}{# Some documentation.}
  35 7 \textcolor{comment}{}\textcolor{comment}{  }\textcolor{keyword}{variable} ns\_var\textcolor{comment}{}
  36 8 \textcolor{comment}{}  \textcolor{comment}{## Documented itcl class \(\backslash\)c itcl\_class .}
  37 9 \textcolor{comment}{}\textcolor{comment}{  }\textcolor{keyword}{itcl::class} itcl\_class \{
  38 10     \textcolor{comment}{## Create object.}
  39 11 \textcolor{comment}{}\textcolor{comment}{    }\textcolor{keyword}{constructor} \{args\} \{\textcolor{keyword}{eval} $args\}\textcolor{comment}{}
  40 12 \textcolor{comment}{}    \textcolor{comment}{## Destroy object.}
  41 13 \textcolor{comment}{}\textcolor{comment}{    }\textcolor{keyword}{destructor} \{\textcolor{keyword}{exit}\}\textcolor{comment}{}
  42 14 \textcolor{comment}{}    \textcolor{comment}{## Documented itcl method \(\backslash\)c itcl\_method\_x .}
  43 15 \textcolor{comment}{}\textcolor{comment}{    }\textcolor{comment}{# param[in] arg Argument}
  44 16 \textcolor{comment}{}\textcolor{comment}{    }\textcolor{keyword}{private} \textcolor{keyword}{method} itcl\_method\_x \{arg\}\{\}\textcolor{comment}{}
  45 17 \textcolor{comment}{}    \textcolor{comment}{## Documented itcl method \(\backslash\)c itcl\_method\_y .}
  46 18 \textcolor{comment}{}\textcolor{comment}{    }\textcolor{comment}{# param[in] arg Argument}
  47 19 \textcolor{comment}{}\textcolor{comment}{    }\textcolor{keyword}{protected} \textcolor{keyword}{method} itcl\_method\_y \{arg\} \{\}\textcolor{comment}{}
  48 20 \textcolor{comment}{}    \textcolor{comment}{## Documented itcl method \(\backslash\)c itcl\_method\_z .}
  49 21 \textcolor{comment}{}\textcolor{comment}{    }\textcolor{comment}{# param[in] arg Argument}
  50 22 \textcolor{comment}{}\textcolor{comment}{    }\textcolor{keyword}{public} \textcolor{keyword}{method} itcl\_method\_z \{arg\} \{\}\textcolor{comment}{}
  51 23 \textcolor{comment}{}    \textcolor{comment}{## Documented common itcl var \(\backslash\)c itcl\_Var .}
  52 24 \textcolor{comment}{}\textcolor{comment}{    }\textcolor{keyword}{common} itcl\_Var\textcolor{comment}{}
  53 25 \textcolor{comment}{}    \textcolor{comment}{## \(\backslash\)protectedsection}
  54 26 \textcolor{comment}{}\textcolor{comment}{    }
  55 27     \textcolor{keyword}{variable} itcl\_var1\textcolor{comment}{;#< Documented itcl var \(\backslash\)c itcl\_var1 .}
  56 28 \textcolor{comment}{    }\textcolor{keyword}{variable} itcl\_var2\}\textcolor{comment}{}
  57 29 \textcolor{comment}{}  \textcolor{comment}{## Documented oo class \(\backslash\)c oo\_class .}
  58 30 \textcolor{comment}{}\textcolor{comment}{  }\textcolor{keyword}{oo::class} create oo\_class \{
  59 31     \textcolor{comment}{## Create object.}
  60 32 \textcolor{comment}{}\textcolor{comment}{    }\textcolor{comment}{# Configure with args}
  61 33 \textcolor{comment}{}\textcolor{comment}{    }\textcolor{keyword}{constructor} \{args\} \{\textcolor{keyword}{eval} $args\}\textcolor{comment}{}
  62 34 \textcolor{comment}{}    \textcolor{comment}{## Destroy object.}
  63 35 \textcolor{comment}{}\textcolor{comment}{    }\textcolor{comment}{# Exit.}
  64 36 \textcolor{comment}{}\textcolor{comment}{    }\textcolor{keyword}{destructor} \{\textcolor{keyword}{exit}\}\textcolor{comment}{}
  65 37 \textcolor{comment}{}    \textcolor{comment}{## Documented oo var \(\backslash\)c oo\_var .}
  66 38 \textcolor{comment}{}\textcolor{comment}{    }\textcolor{comment}{# Defined inside class}
  67 39 \textcolor{comment}{}\textcolor{comment}{    }\textcolor{keyword}{variable} oo\_var\textcolor{comment}{}
  68 40 \textcolor{comment}{}    \textcolor{comment}{## \(\backslash\)private Documented oo method \(\backslash\)c oo\_method\_x .}
  69 41 \textcolor{comment}{}\textcolor{comment}{    }\textcolor{comment}{# param[in] arg Argument}
  70 42 \textcolor{comment}{}\textcolor{comment}{    }\textcolor{keyword}{method} oo\_method\_x \{arg\} \{\}\textcolor{comment}{}
  71 43 \textcolor{comment}{}    \textcolor{comment}{## \(\backslash\)protected Documented oo method \(\backslash\)c oo\_method\_y .}
  72 44 \textcolor{comment}{}\textcolor{comment}{    }\textcolor{comment}{# param[in] arg Argument}
  73 45 \textcolor{comment}{}\textcolor{comment}{    }\textcolor{keyword}{method} oo\_method\_y \{arg\} \{\}\textcolor{comment}{}
  74 46 \textcolor{comment}{}    \textcolor{comment}{## \(\backslash\)public Documented oo method \(\backslash\)c oo\_method\_z .}
  75 47 \textcolor{comment}{}\textcolor{comment}{    }\textcolor{comment}{# param[in] arg Argument}
  76 48 \textcolor{comment}{}\textcolor{comment}{    }\textcolor{keyword}{method} oo\_method\_z \{arg\} \{\}\textcolor{comment}{}
  77 49 \textcolor{comment}{}  \}\textcolor{comment}{}
  78 50 \textcolor{comment}{}\}
  79 \end{DoxyCode}
  80
  81
  82 \subsubsection{Function Documentation}
  83 \hypertarget{namespacens_a1429cbe84d32b17ea4783e5c5c00615b}{}\label{namespacens_a1429cbe84d32b17ea4783e5c5c00615b}
  84 \index{ns@{ns}!ns\+\_\+proc@{ns\+\_\+proc}}
  85 \index{ns\+\_\+proc@{ns\+\_\+proc}!ns@{ns}}
  86 \paragraph{\texorpdfstring{ns\+\_\+proc()}{ns\_proc()}}
  87 {\footnotesize\ttfamily ns\+::ns\+\_\+proc\begin{DoxyParamCaption}\item[{}]{arg  }\end{DoxyParamCaption}}
  88
  89
  90
  91 Documented proc {\ttfamily ns\+\_\+proc} .
  92
  93 param\mbox{[}in\mbox{]} arg some argument
  94 \begin{DoxyCode}
  95 14   \textcolor{keyword}{proc} ns\_proc \{arg\} \{\}
  96 \end{DoxyCode}