Class documentation: System.doc.outputters.html_document

HTML document class.

Inherits

System.doc.outputters.base_document

Classes contained

Constructors

• make System.doc.outputters.html_document(filename, title): Create new HTML document.
  • filename: File to create (excluding .html)
  • title: Title of document.

Destructor

Operators

Properties

• filehandle: HTML document's file object.
• footer: HTML footer to include on generated documentation
• header: HTML header to include on generated documentation

Methods

• begin_list(): Begin list of items.
• begin_list_entry(name, description): Begin list entry.
  • name: Name of list entry.
  • description: Description of list entry.
• close(): Close document.
• end_list(): End list of items.
• end_list_entry(): End list entry.
• file_name(name): Return actual file name of document
  • name: Name of document
• link(name, location): Output link to given location.
  • name: Name of section
  • location: Location to link to
• paragraph(text): Output paragraph of text.
  • text: Text for paragraph.
• section(name): Output section to file.
  • name: Name of section
• sub_list_entry(name, description): Begin sublist entry.
  • name: Name of sublist entry.
  • description: Description of sublist entry.
• subsection(name): Output subsection to file.
  • name: Name of subsection
• subsubsection(name): Output sub-sub-section to file.
  • name: Name of sub-sub-section