Modules | Files | Inheritance Tree | Inheritance Graph | Name Index | Config
module Synopsis::Formatter::HTML::ASTFormatter
class Summary
Files: Synopsis/Formatter/HTML/ASTFormatter.py
Summary-inheritance Scopes/Synopsis/Formatter/HTML/ASTFormatter/Part.html

Formatting summary visitor. This formatter displays a summary for each declaration, with links to the details if there is one. All of this is controlled by the ASTFormatters.


Operations Summary:
 __init__(self, page) [Source]
 _init_default_formatters(self) [Source]
 set_link_detail(self, boolean)
Sets link_detail flag to given value. [Source]
 label(self, ref, label = None)
Override to check link_detail flag. [Source]
 writeSectionStart(self, heading)
Starts a table entity. [Source]
 writeSectionEnd(self, heading)
Closes the table entity and adds a break. [Source]
 writeSectionItem(self, text)
Adds a table row [Source]
 process(self, decl)
Print out the summaries from the given decl [Source]

Operations Inherited from Part
page, filename, os, scope, write, _init_formatters, addFormatter, type_ref, type_label, declarator, parameter, reference, formatDeclaration, visitDeclaration, visitForward, visitGroup, visitScope, visitModule, visitMetaModule, visitClass, visitTypedef, visitEnum, visitVariable, visitConst, visitFunction, visitOperation, formatType, visitBaseType, visitUnknown, visitDeclared, visitDependent, visitModifier, visitParametrized, visitTemplate, visitFunctionType, write_start, write_end

Operation Details:
  set_link_detail(self, boolean)

Sets link_detail flag to given value.

See Also:
label()


  label(self, ref, label = None)

Override to check link_detail flag. If it's set, returns a reference instead - which will be to the detailed info


  writeSectionStart(self, heading)

Starts a table entity. The heading is placed in a row in a td with the class 'heading'.