Modules | Files | Inheritance Tree | Inheritance Graph | Name Index | Config
module Synopsis::Formatter::HTML::CommentFormatter
class CommentFormatter
Files: Synopsis/Formatter/HTML/CommentFormatter.py

A class that takes a Declaration and formats its comments into a string.

Operations Summary:
 __init__(self) [Source]
 format(self, page, decl)
Formats the first comment of the given AST.Declaration. [Source]
 format_summary(self, page, decl)
Formats the summary of the first comment of the given AST.Declaration. [Source]

Operation Details:
  format(self, page, decl)

Formats the first comment of the given AST.Declaration. Note that the Linker.Comments.Summarizer CommentProcessor is supposed to have combined all comments first in the Linker stage.

Return:
the formatted text

  format_summary(self, page, decl)

Formats the summary of the first comment of the given AST.Declaration. Note that the Linker.Comments.Summarizer CommentProcessor is supposed to have combined all comments first in the Linker stage.

Return:
the formatted summary text