module Synopsis.Formatters.HTML.Fragment
class Fragment
Fragment-inheritance
Generates HTML fragment for a declaration. Multiple strategies are combined to generate the output for a single declaration, allowing the user to customise the output by choosing a set of strategies. This follows the Strategy design pattern. The key concept of this class is the format* methods. Any class derived from Strategy that overrides one of the format methods will have that method called by the Summary and Detail formatters when they visit that ASG type. Summary and Detail maintain a list of Strategies, and a list for each ASG type. For example, when Strategy.Summary visits a Function object, it calls the formatFunction method on all Strategys registed with SummaryFormatter that implemented that method. Each of these format methods returns a string, which may contain a TD tag to create a new column. An important point to note is that only Strategies which override a particular format method are called - if that format method is not overridden then it is not called for that declaration type.
Methods Summary:
  register(self, formatter)
references
source code
Store formatter as self.formatter.
  format_modifiers(self, modifiers)
references
source code
Returns a HTML string from the given list of string modifiers.
  format_declaration(self, decl)
references
source code
  format_macro(self, decl)
references
source code
  format_forward(self, decl)
references
source code
  format_group(self, decl)
references
source code
  format_scope(self, decl)
references
source code
  format_module(self, decl)
references
source code
  format_meta_module(self, decl)
references
source code
  format_class(self, decl)
references
source code
  format_class_template(self, decl)
references
source code
  format_typedef(self, decl)
references
source code
  format_enum(self, decl)
references
source code
  format_variable(self, decl)
references
source code
  format_const(self, decl)
references
source code
  format_function(self, decl)
references
source code
  format_function_template(self, decl)
references
source code
  format_operation(self, decl)
references
source code
references
source code
Methods Details:
  register(self, formatter)
references
source code
Store formatter as self.formatter. The formatter is either a SummaryFormatter or DetailFormatter, and is used for things like reference() and label() calls. Local references to the formatter's reference and label methods are stored in self for more efficient use of them.
  format_modifiers(self, modifiers)
references
source code
Returns a HTML string from the given list of string modifiers. The modifiers are enclosed in 'keyword' spans.