| | |
Methods defined here:
- __init__(self, name)
- __str__(self)
- cpp_docs(self, html)
- Set the file name for the C++ documentation of this routine
within the online Boost Graph Library documentation. This
should be a full file name, e.g.,
"bellman_ford_shortest.html", but is only required to be
specified when the default (name + ".html") is incorrect. Note
that "html" may be None to indicate that no link to the C++
documentation should be provided.
- example(self, example)
- Add example code, written in Python of course.
- paragraph(self, para)
- Add a paragraph of descriptive text.
- parameter(self, name, doc, default=None)
- Declares a function parameter given its name, a documentation
string, and (optionally) a string containing its default
value.
- result(self, type)
- Declares the type that will be returned by the function.
- see_also(self, other)
- Add the name of something else that the might want to refer
to.
- signature(self, parameters, result=None)
- Add a signature for the function. parameters is a tuple
containing the names of the parameters used in the signature
and result is the result type. If no signatures are added, a
signature will be generated from the parameters.
|