module Synopsis.Formatters.HTML.Fragments.DeclarationFormatter
class DeclarationFormatter
DeclarationFormatter-inheritance Scopes/Synopsis/Formatters/HTML/Fragments/DeclarationFormatter/DeclarationDetailFormatter.html Scopes/Synopsis/Parsers/C/C/Parser.html Scopes/Synopsis/Formatters/HTML/Fragments/DeclarationFormatter/DeclarationSummaryFormatter.html Scopes/Synopsis/Formatters/Dot/Formatter.html
Base class for SummaryFormatter and DetailFormatter. The two classes SummaryFormatter and DetailFormatter are actually very similar in operation, and so most of their methods are defined here. Both of them print out the definition of the declarations, including type, parameters, etc. Some things such as exception specifications are only printed out in the detailed version.
Methods Summary:
  register(self, formatter)
references
source code
  format_parameters(self, parameters)
references
source code
Returns formatted string for the given parameter list.
  format_declaration(self, decl)
references
source code
The default is to return no type and just the declarations name for the name.
  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
Scopes have their own views, so return a reference to it.
  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_enumerator(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
  format_parameter(self, parameter)
references
source code
Methods Details:
  format_parameters(self, parameters)
references
source code
Returns formatted string for the given parameter list.
  format_declaration(self, decl)
references
source code
The default is to return no type and just the declarations name for the name.
  format_scope(self, decl)
references
source code
Scopes have their own views, so return a reference to it.
  format_typedef(self, decl)
references
source code
(typedef type, typedef name)
  format_enumerator(self, decl)
references
source code
This is only called by formatEnum
  format_enum(self, decl)
references
source code
(enum name, list of enumerator names)
  format_const(self, decl)
references
source code
(const type, const name = const value)
  format_function(self, decl)
references
source code
(return type, func + params + exceptions)
  format_function_template(self, decl)
references
source code
(return type, func + params + exceptions)
  format_parameter(self, parameter)
references
source code
Returns one string for the given parameter