xorp

Xif::kdoc::XifKdocThing Class Reference

List of all members.

Public Member Functions

def __init__
def add_kdoc_param
def output_kdoc

Private Attributes

 _params
 _master
 _other

Constructor & Destructor Documentation

def Xif::kdoc::XifKdocThing::__init__ (   self,
  kdoc_comment 
)
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.

Member Function Documentation

def Xif::kdoc::XifKdocThing::add_kdoc_param (   self,
  name,
  description 
)
Add a kdoc @param value and description
def Xif::kdoc::XifKdocThing::output_kdoc (   self,
  indent_string,
  paramlist,
  comment = "",
  width = 80 
)
Output kdoc comments with inserted comment and only for parameters
named in paramlist.

The documentation for this class was generated from the following file:
 All Classes Namespaces Functions Variables Typedefs Enumerations