diff options
Diffstat (limited to 'vnfs/VES5.0/doxygen-1.8.12/html/examples/tclexample/latex/namespacens.tex')
-rw-r--r-- | vnfs/VES5.0/doxygen-1.8.12/html/examples/tclexample/latex/namespacens.tex | 96 |
1 files changed, 96 insertions, 0 deletions
diff --git a/vnfs/VES5.0/doxygen-1.8.12/html/examples/tclexample/latex/namespacens.tex b/vnfs/VES5.0/doxygen-1.8.12/html/examples/tclexample/latex/namespacens.tex new file mode 100644 index 00000000..6065fba3 --- /dev/null +++ b/vnfs/VES5.0/doxygen-1.8.12/html/examples/tclexample/latex/namespacens.tex @@ -0,0 +1,96 @@ +\hypertarget{namespacens}{}\subsection{ns Namespace Reference} +\label{namespacens}\index{ns@{ns}} + + +Documented namespace {\ttfamily ns} . + + +\subsubsection*{Classes} +\begin{DoxyCompactItemize} +\item +class \hyperlink{classns_1_1itcl__class}{itcl\+\_\+class} +\begin{DoxyCompactList}\small\item\em Documented itcl class {\ttfamily \hyperlink{classns_1_1itcl__class}{itcl\+\_\+class}} . \end{DoxyCompactList}\item +class \hyperlink{classns_1_1oo__class}{oo\+\_\+class} +\begin{DoxyCompactList}\small\item\em Documented oo class {\ttfamily \hyperlink{classns_1_1oo__class}{oo\+\_\+class}} . \end{DoxyCompactList}\end{DoxyCompactItemize} +\subsubsection*{Functions} +\begin{DoxyCompactItemize} +\item +\hyperlink{namespacens_a1429cbe84d32b17ea4783e5c5c00615b}{ns\+\_\+proc} arg +\begin{DoxyCompactList}\small\item\em Documented proc {\ttfamily ns\+\_\+proc} . \end{DoxyCompactList}\end{DoxyCompactItemize} + + +\subsubsection{Detailed Description} +Documented namespace {\ttfamily ns} . + +The code is inserted here\+: + + +\begin{DoxyCode} +1 \textcolor{keyword}{namespace} \textcolor{keyword}{eval} ns \{ +2 \textcolor{comment}{## Documented proc \(\backslash\)c ns\_proc .} +3 \textcolor{comment}{}\textcolor{comment}{ }\textcolor{comment}{# param[in] arg some argument} +4 \textcolor{comment}{}\textcolor{comment}{ }\textcolor{keyword}{proc} ns\_proc \{arg\} \{\}\textcolor{comment}{} +5 \textcolor{comment}{} \textcolor{comment}{## Documented var \(\backslash\)c ns\_var .} +6 \textcolor{comment}{}\textcolor{comment}{ }\textcolor{comment}{# Some documentation.} +7 \textcolor{comment}{}\textcolor{comment}{ }\textcolor{keyword}{variable} ns\_var\textcolor{comment}{} +8 \textcolor{comment}{} \textcolor{comment}{## Documented itcl class \(\backslash\)c itcl\_class .} +9 \textcolor{comment}{}\textcolor{comment}{ }\textcolor{keyword}{itcl::class} itcl\_class \{ +10 \textcolor{comment}{## Create object.} +11 \textcolor{comment}{}\textcolor{comment}{ }\textcolor{keyword}{constructor} \{args\} \{\textcolor{keyword}{eval} $args\}\textcolor{comment}{} +12 \textcolor{comment}{} \textcolor{comment}{## Destroy object.} +13 \textcolor{comment}{}\textcolor{comment}{ }\textcolor{keyword}{destructor} \{\textcolor{keyword}{exit}\}\textcolor{comment}{} +14 \textcolor{comment}{} \textcolor{comment}{## Documented itcl method \(\backslash\)c itcl\_method\_x .} +15 \textcolor{comment}{}\textcolor{comment}{ }\textcolor{comment}{# param[in] arg Argument} +16 \textcolor{comment}{}\textcolor{comment}{ }\textcolor{keyword}{private} \textcolor{keyword}{method} itcl\_method\_x \{arg\}\{\}\textcolor{comment}{} +17 \textcolor{comment}{} \textcolor{comment}{## Documented itcl method \(\backslash\)c itcl\_method\_y .} +18 \textcolor{comment}{}\textcolor{comment}{ }\textcolor{comment}{# param[in] arg Argument} +19 \textcolor{comment}{}\textcolor{comment}{ }\textcolor{keyword}{protected} \textcolor{keyword}{method} itcl\_method\_y \{arg\} \{\}\textcolor{comment}{} +20 \textcolor{comment}{} \textcolor{comment}{## Documented itcl method \(\backslash\)c itcl\_method\_z .} +21 \textcolor{comment}{}\textcolor{comment}{ }\textcolor{comment}{# param[in] arg Argument} +22 \textcolor{comment}{}\textcolor{comment}{ }\textcolor{keyword}{public} \textcolor{keyword}{method} itcl\_method\_z \{arg\} \{\}\textcolor{comment}{} +23 \textcolor{comment}{} \textcolor{comment}{## Documented common itcl var \(\backslash\)c itcl\_Var .} +24 \textcolor{comment}{}\textcolor{comment}{ }\textcolor{keyword}{common} itcl\_Var\textcolor{comment}{} +25 \textcolor{comment}{} \textcolor{comment}{## \(\backslash\)protectedsection} +26 \textcolor{comment}{}\textcolor{comment}{ } +27 \textcolor{keyword}{variable} itcl\_var1\textcolor{comment}{;#< Documented itcl var \(\backslash\)c itcl\_var1 .} +28 \textcolor{comment}{ }\textcolor{keyword}{variable} itcl\_var2\}\textcolor{comment}{} +29 \textcolor{comment}{} \textcolor{comment}{## Documented oo class \(\backslash\)c oo\_class .} +30 \textcolor{comment}{}\textcolor{comment}{ }\textcolor{keyword}{oo::class} create oo\_class \{ +31 \textcolor{comment}{## Create object.} +32 \textcolor{comment}{}\textcolor{comment}{ }\textcolor{comment}{# Configure with args} +33 \textcolor{comment}{}\textcolor{comment}{ }\textcolor{keyword}{constructor} \{args\} \{\textcolor{keyword}{eval} $args\}\textcolor{comment}{} +34 \textcolor{comment}{} \textcolor{comment}{## Destroy object.} +35 \textcolor{comment}{}\textcolor{comment}{ }\textcolor{comment}{# Exit.} +36 \textcolor{comment}{}\textcolor{comment}{ }\textcolor{keyword}{destructor} \{\textcolor{keyword}{exit}\}\textcolor{comment}{} +37 \textcolor{comment}{} \textcolor{comment}{## Documented oo var \(\backslash\)c oo\_var .} +38 \textcolor{comment}{}\textcolor{comment}{ }\textcolor{comment}{# Defined inside class} +39 \textcolor{comment}{}\textcolor{comment}{ }\textcolor{keyword}{variable} oo\_var\textcolor{comment}{} +40 \textcolor{comment}{} \textcolor{comment}{## \(\backslash\)private Documented oo method \(\backslash\)c oo\_method\_x .} +41 \textcolor{comment}{}\textcolor{comment}{ }\textcolor{comment}{# param[in] arg Argument} +42 \textcolor{comment}{}\textcolor{comment}{ }\textcolor{keyword}{method} oo\_method\_x \{arg\} \{\}\textcolor{comment}{} +43 \textcolor{comment}{} \textcolor{comment}{## \(\backslash\)protected Documented oo method \(\backslash\)c oo\_method\_y .} +44 \textcolor{comment}{}\textcolor{comment}{ }\textcolor{comment}{# param[in] arg Argument} +45 \textcolor{comment}{}\textcolor{comment}{ }\textcolor{keyword}{method} oo\_method\_y \{arg\} \{\}\textcolor{comment}{} +46 \textcolor{comment}{} \textcolor{comment}{## \(\backslash\)public Documented oo method \(\backslash\)c oo\_method\_z .} +47 \textcolor{comment}{}\textcolor{comment}{ }\textcolor{comment}{# param[in] arg Argument} +48 \textcolor{comment}{}\textcolor{comment}{ }\textcolor{keyword}{method} oo\_method\_z \{arg\} \{\}\textcolor{comment}{} +49 \textcolor{comment}{} \}\textcolor{comment}{} +50 \textcolor{comment}{}\} +\end{DoxyCode} + + +\subsubsection{Function Documentation} +\hypertarget{namespacens_a1429cbe84d32b17ea4783e5c5c00615b}{}\label{namespacens_a1429cbe84d32b17ea4783e5c5c00615b} +\index{ns@{ns}!ns\+\_\+proc@{ns\+\_\+proc}} +\index{ns\+\_\+proc@{ns\+\_\+proc}!ns@{ns}} +\paragraph{\texorpdfstring{ns\+\_\+proc()}{ns\_proc()}} +{\footnotesize\ttfamily ns\+::ns\+\_\+proc\begin{DoxyParamCaption}\item[{}]{arg }\end{DoxyParamCaption}} + + + +Documented proc {\ttfamily ns\+\_\+proc} . + +param\mbox{[}in\mbox{]} arg some argument +\begin{DoxyCode} +14 \textcolor{keyword}{proc} ns\_proc \{arg\} \{\} +\end{DoxyCode} |