Contents Class: Formatter
<<Method: Formatter.write_multi_module_header<< >>Method: Formatter.write_index>>
Method: Formatter.write_fn_synopsis
Synopsis: write_fn_synopsis( self, context, argspec, base_implementations, related_implementations, unrelated_implementations, metainfo
)
- Related implementations in classes:
-
FormatterHTB,
FormatterLaTeX
Print the synopsis of a function element.
- context:
- This is an instance of
FormattingContext
describing
the object that is currently documented.
context.memberName(
) is
the name of the function.
- argspec:
- The description of formal parameters in a format
as returned by
inspect.getargspec()
.
- base implementations:
- A list of context descriptions (class
FormattingContext
)
representing base classes implementing the same method name.
- related implementations:
- A list of context descriptions (class
FormattingContext
)
representing classes connected to the class in
context
by inheritance and implementing the same method name.
- unrelated implementations:
- A list of context descriptions (class
FormattingContext
)
representing classes connected without an inheritance link to the class in
context
but implementing the same method name.
- metainfo:
- An instance of
MetaInfo
.
Elements:
none
Generated by pymanual (c) 2005-2006 on August 02, 2006.