Home | Trees | Index | Help |
|
---|
Package yagdoc :: Module docbook :: Class Section |
|
object
--+
|
Section
Method Summary | |
---|---|
__init__(self,
name)
| |
str
|
Describe declaration type in human terms. |
Set own_symbol and docblock (if present in documentation). | |
format(self,
documentation,
inspector)
| |
Format page-bottom block. | |
Format data synopsis block, if there are any data. | |
Format data details. | |
Format section body. | |
Format function synopsis block, if there are any functions. | |
Format function details. | |
Format includes synopsis block, if there are any includes. | |
Format ineritance tree block, if there are any types defined. | |
Format properties synopsis block, if there are any properties defined. | |
Format property details. | |
Format `see also' section. | |
Format signal details. | |
format_signal_subsymbol(self,
name,
smap,
docblock,
kind,
empty)
| |
format_signal_subsymbols(self,
sname,
signal,
smap)
| |
Format signal synopsis block, if there are any signals defined. | |
Format subsymbols of a declaration. | |
Format synopsis block. | |
Format page-top block with title and metadata. | |
Format type information subsection. | |
Format type information table of one type. | |
tuple of str
|
Format a section wrapper. |
make_symbol_section(self,
title,
xmlid,
kind)
| |
Match signal arguments to documented subsymbols | |
Mark documentation as used. | |
_fail(self,
exception,
symbol,
detail)
| |
Inherited from object :
__delattr__ ,
__getattribute__ ,
__hash__ ,
__new__ ,
__reduce__ ,
__reduce_ex__ ,
__repr__ ,
__setattr__ ,
__str__
|
Instance Variable Summary | |
---|---|
list of scanner.Declaration |
declarations : List of regular declarations. |
docblock.DocBlock or
None |
docblock : Section's own documentation block. |
str |
name : Section name (header file name, or whatever we have got from
sectionizer). |
str |
own_symbol : Symbol name of section documentation, formed with common.section_symbol . |
list of str |
types : List of types (GTypes) in this section. |
Class Variable Summary | |
---|---|
str |
boxchars_ascii = '| -+`'
|
unicode |
boxchars_utf8 = u'\u2502 \u2500\u251c\u2514'
|
unicode |
boxchars_utf8bold = u'\u2503 \u2501\u2523\u2517'
|
dict |
type_flag_names = {32: 'abstract', 1: 'fundamental', 2: ...
|
Method Details |
---|
data_symbol_kind(self, decl)Describe declaration type in human terms.
|
find_own_docblock(self, documentation)Setown_symbol and docblock (if present in
documentation).
|
format_bottom(self)Format page-bottom block. |
format_data(self)Format data synopsis block, if there are any data. |
format_data_details(self)Format data details. |
format_description(self)Format section body. |
format_func(self)Format function synopsis block, if there are any functions. |
format_func_details(self)Format function details. |
format_includes(self)Format includes synopsis block, if there are any includes. |
format_inheritance_tree(self)Format ineritance tree block, if there are any types defined. |
format_properties(self, ptype=None)Format properties synopsis block, if there are any properties defined.
|
format_property_details(self, ptype=None)Format property details.
|
format_see_also(self)Format `see also' section. |
format_signal_details(self)Format signal details. |
format_signals(self)Format signal synopsis block, if there are any signals defined. |
format_subsymbols(self, decl)Format subsymbols of a declaration. The subsymbols are formatted as a<variablelist>
tree, with nested symbols forming nested trees.
|
format_synopsis(self)Format synopsis block. Also createsdata_symbols and func_symbols
lists, containing declarations sorted according to their kind.
|
format_top(self)Format page-top block with title and metadata. |
format_type_information(self)Format type information subsection. |
format_type_information_table(self, name, lines)Format type information table of one type.
|
make_section(self, title, section=None, element=None, container=None, level=1)Format a section wrapper.
|
sort_out_signal_subsymbols(self, sname, signal)Match signal arguments to documented subsymbols This is done heuristically, based on subsymbols position in the documentation. |
use_docs(self, decl_name, symbols, required=(), optional=())Mark documentation as used. Empty symbol name is used for description bodies.
|
Instance Variable Details |
---|
declarationsList of regular declarations.
|
docblockSection's own documentation block.
|
nameSection name (header file name, or whatever we have got from sectionizer).
|
own_symbolSymbol name of section documentation, formed withcommon.section_symbol .
|
typesList of types (GTypes) in this section.
|
Class Variable Details |
---|
boxchars_ascii
|
boxchars_utf8
|
boxchars_utf8bold
|
type_flag_names
|
Home | Trees | Index | Help |
|
---|
Generated by Epydoc 2.1 on Fri Oct 5 00:36:53 2007 | http://epydoc.sf.net |