Modules | Files | Inheritance Tree | Inheritance Graph | Name Index | Config
module Synopsis::Formatter::HTML::CommentFormatter
class CommentFormatterStrategy
Files: Synopsis/Formatter/HTML/CommentFormatter.py
CommentFormatterStrategy-inheritance Scopes/Synopsis/Formatter/HTML/CommentFormatter/SectionFormatter.html Scopes/Synopsis/Formatter/HTML/CommentFormatter/JavadocFormatter.html Scopes/Synopsis/Formatter/HTML/CommentFormatter/QuoteHTML.html

Interface class that takes a comment and formats its summary and/or detail strings.

Operations Summary:
 format(self, page, decl, text)
Format the given comment [Source]
 format_summary(self, page, decl, summary)
Format the given comment summary [Source]

Operation Details:
  format(self, page, decl, text)

Format the given comment

Parameters:
page - the Page to use for references and determining the correct relative filename.
decl - the declaration
text - the comment text to format

  format_summary(self, page, decl, summary)

Format the given comment summary

Parameters:
page - the Page to use for references and determining the correct relative filename.
decl - the declaration
summary - the comment summary to format