yagdoc.docbook.Section

Package yagdoc :: Module docbook :: Class Section

[show private | hide private]

Type Section

object --+
         |
        Section

One reference documentation section.

Method Summary
	`__init__(self, name)`
`str`	`data_symbol_kind(self, decl)` Describe declaration type in human terms.
	`find_own_docblock(self, documentation)` Set `own_symbol` and `docblock` (if present in documentation).
	`format(self, documentation, inspector)`
	`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)` Format properties synopsis block, if there are any properties defined.
	`format_property_details(self, ptype)` Format property details.
	`format_see_also(self)` Format `see also' section.
	`format_signal_details(self)` Format signal details.
	`format_signal_subsymbol(self, name, smap, docblock, kind, empty)`
	`format_signal_subsymbols(self, sname, signal, smap)`
	`format_signals(self)` Format signal synopsis block, if there are any signals defined.
	`format_subsymbols(self, decl)` Format subsymbols of a declaration.
	`format_synopsis(self)` Format synopsis block.
	`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.
`tuple` of `str`	`make_section(self, title, section, element, container, level)` Format a section wrapper.
	`make_symbol_section(self, title, xmlid, kind)`
	`sort_out_signal_subsymbols(self, sname, signal)` Match signal arguments to documented subsymbols
	`use_docs(self, decl_name, symbols, required, optional)` Mark documentation as used.
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.

Parameters:: decl - Declaration to describe.
(type=scanner.Declaration)

Returns:: One-word string describing the declaration, such as 'macro', 'typedef' or 'class'.
(type=str)

find_own_docblock(self, documentation)

Set own_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.

Parameters:: ptype - Special property name, if unspecified or None normal properties are formatted.
(type=str or None)

format_property_details(self, ptype=None)

Format property details.

Parameters:: ptype - Special property name, if unspecified or None normal properties are formatted.
(type=str or None)

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.

Parameters:: decl - Declaration.
(type=scanner.Declaration)

format_synopsis(self)

Format synopsis block.

Also creates data_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.

Parameters:: name - Type name.
(type=str); lines - Mutable sequence of lines to append the formatted type information to.
(type=sequence)

make_section(self, title, section=None, element=None, container=None, level=1)

Format a section wrapper.

Parameters:: title - Section title. It should be already valid XML.
(type=str); section - Section type, used as the trailing part of section id (the leading part is the top-level section id). If unspecified, lowercase title with spaces replaced with underscores is substituted.
(type=str); element - Section element, for instance <refsect1>. If unspecified, <refsectlevel> is substituted.
(type=str); container - Container element to put the section body to, for instance <synopsis>. If unspecified, none is used.
(type=str); level - Section level, it determines the element if it's unspecified and has no effect if element is explicitly set.
(type=int)

Returns:: Section top and bottom parts, the body should be placed between them.
(type=tuple of str)

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.

Parameters:: decl_name - Top-level symbol name.
(type=str); symbols - List of actually documented symbols.
(type=dict or set); required - Symbols that require documentation, these will be always added to docs_used.
(type=sequence or iterator of str); optional - Optional symbols, these will be added to docs_used only if they are present in symbols
(type=sequence or iterator of str)

Instance Variable Details

declarations

List of regular declarations.

Type:: list of scanner.Declaration

docblock

Section's own documentation block.

Type:: docblock.DocBlock or None

name

Section name (header file name, or whatever we have got from sectionizer).

Type:: str

own_symbol

Symbol name of section documentation, formed with common.section_symbol.

Type:: str

types

List of types (GTypes) in this section.

Type:: list of str

Class Variable Details

boxchars_ascii

Type:: str
Value:: '| -+`'

boxchars_utf8

Type:: unicode
Value:: u'\u2502 \u2500\u251c\u2514'

boxchars_utf8bold

Type:: unicode
Value:: u'\u2503 \u2501\u2523\u2517'

type_flag_names

Type:: dict
Value:: {1: 'fundamental', 2: 'derivable', 4: 'deep derivable', 8: 'instantiable', 16: 'interface', 32: 'abstract', 64: 'classed', 128: '', ...

Generated by Epydoc 2.1 on Fri Oct 5 00:36:53 2007

http://epydoc.sf.net