\hypertarget{classXif_1_1kdoc_1_1XifKdocThing}{
\section{Xif::kdoc::XifKdocThing Class Reference}
\label{classXif_1_1kdoc_1_1XifKdocThing}\index{Xif::kdoc::XifKdocThing@{Xif::kdoc::XifKdocThing}}
}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
def \hyperlink{classXif_1_1kdoc_1_1XifKdocThing_a04ed18b3e74da561c457990479d9eebc}{\_\-\_\-init\_\-\_\-}
\item 
def \hyperlink{classXif_1_1kdoc_1_1XifKdocThing_a8198e2de74bdd652e938c6fb876798f8}{add\_\-kdoc\_\-param}
\item 
def \hyperlink{classXif_1_1kdoc_1_1XifKdocThing_ad8cb39a98653a99dbe29e1b372272ef3}{output\_\-kdoc}
\end{DoxyCompactItemize}
\subsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classXif_1_1kdoc_1_1XifKdocThing_abf1a9c7bbfb1cd82371cd9146d45cc80}{
{\bfseries \_\-params}}
\label{classXif_1_1kdoc_1_1XifKdocThing_abf1a9c7bbfb1cd82371cd9146d45cc80}

\item 
\hypertarget{classXif_1_1kdoc_1_1XifKdocThing_a9da700bef250a4510a703acd502fa7a3}{
{\bfseries \_\-master}}
\label{classXif_1_1kdoc_1_1XifKdocThing_a9da700bef250a4510a703acd502fa7a3}

\item 
\hypertarget{classXif_1_1kdoc_1_1XifKdocThing_a4d545ee0a9cc2f843af39bfc22cd6c74}{
{\bfseries \_\-other}}
\label{classXif_1_1kdoc_1_1XifKdocThing_a4d545ee0a9cc2f843af39bfc22cd6c74}

\end{DoxyCompactItemize}


\subsection{Constructor \& Destructor Documentation}
\hypertarget{classXif_1_1kdoc_1_1XifKdocThing_a04ed18b3e74da561c457990479d9eebc}{
\index{Xif::kdoc::XifKdocThing@{Xif::kdoc::XifKdocThing}!\_\-\_\-init\_\-\_\-@{\_\-\_\-init\_\-\_\-}}
\index{\_\-\_\-init\_\-\_\-@{\_\-\_\-init\_\-\_\-}!Xif::kdoc::XifKdocThing@{Xif::kdoc::XifKdocThing}}
\subsubsection[{\_\-\_\-init\_\-\_\-}]{\setlength{\rightskip}{0pt plus 5cm}def Xif::kdoc::XifKdocThing::\_\-\_\-init\_\-\_\- (
\begin{DoxyParamCaption}
\item[{}]{self, }
\item[{}]{kdoc\_\-comment}
\end{DoxyParamCaption}
)}}
\label{classXif_1_1kdoc_1_1XifKdocThing_a04ed18b3e74da561c457990479d9eebc}
\begin{DoxyVerb}
Parse kdoc comment into main comment, other stuff, and
list of @param arguments.  The object can then be used to
generate nicely formatted kdoc comments.
\end{DoxyVerb}
 

\subsection{Member Function Documentation}
\hypertarget{classXif_1_1kdoc_1_1XifKdocThing_a8198e2de74bdd652e938c6fb876798f8}{
\index{Xif::kdoc::XifKdocThing@{Xif::kdoc::XifKdocThing}!add\_\-kdoc\_\-param@{add\_\-kdoc\_\-param}}
\index{add\_\-kdoc\_\-param@{add\_\-kdoc\_\-param}!Xif::kdoc::XifKdocThing@{Xif::kdoc::XifKdocThing}}
\subsubsection[{add\_\-kdoc\_\-param}]{\setlength{\rightskip}{0pt plus 5cm}def Xif::kdoc::XifKdocThing::add\_\-kdoc\_\-param (
\begin{DoxyParamCaption}
\item[{}]{self, }
\item[{}]{name, }
\item[{}]{description}
\end{DoxyParamCaption}
)}}
\label{classXif_1_1kdoc_1_1XifKdocThing_a8198e2de74bdd652e938c6fb876798f8}
\begin{DoxyVerb}Add a kdoc @param value and description\end{DoxyVerb}
 \hypertarget{classXif_1_1kdoc_1_1XifKdocThing_ad8cb39a98653a99dbe29e1b372272ef3}{
\index{Xif::kdoc::XifKdocThing@{Xif::kdoc::XifKdocThing}!output\_\-kdoc@{output\_\-kdoc}}
\index{output\_\-kdoc@{output\_\-kdoc}!Xif::kdoc::XifKdocThing@{Xif::kdoc::XifKdocThing}}
\subsubsection[{output\_\-kdoc}]{\setlength{\rightskip}{0pt plus 5cm}def Xif::kdoc::XifKdocThing::output\_\-kdoc (
\begin{DoxyParamCaption}
\item[{}]{self, }
\item[{}]{indent\_\-string, }
\item[{}]{paramlist, }
\item[{}]{comment = {\ttfamily \char`\"{}\char`\"{}}, }
\item[{}]{width = {\ttfamily 80}}
\end{DoxyParamCaption}
)}}
\label{classXif_1_1kdoc_1_1XifKdocThing_ad8cb39a98653a99dbe29e1b372272ef3}
\begin{DoxyVerb}
Output kdoc comments with inserted comment and only for parameters
named in paramlist.
\end{DoxyVerb}
 

The documentation for this class was generated from the following file:\begin{DoxyCompactItemize}
\item 
/home/greearb/git/xorp.ct.github/xorp/xrl/scripts/Xif/kdoc.py\end{DoxyCompactItemize}
