Class WebPage.

Inherits Garbage

The WebPage class provides documentation output to a web page.

It implements the same functions as Output, but they're not static, and is called when Output's static functions are called.

WebPage::WebPage( const char * dir )

Constructs a web page generator that'll write to files in directory dir.

void WebPage::addArgument( const String & text )

As Output::addArgument(). text is output in italics.

void WebPage::addClass( const String & text, Class * c )

As Output::addClass(). If part of text corresponds to the name of c, then only that part is made into a link, otherwise all of text is made into a link.

void WebPage::addFunction( const String & text, Function * f )

As Output::addFunction(). If part of text corresponds to the name of f, then only that part is made into a link, otherwise all of text is made into a link.

void WebPage::addLink( const String & url, const String & title )

Adds a link to url with the given title.

void WebPage::addText( const String & text )

As Output::addText(). text is used escaped (& etc).

String WebPage::anchor( Function * f )

This private helper returns the anchor (sans '#') corresponding to f.

static WebPage * WebPage::current()

Returns a pointer to the most recently constructed WebPage object, or a null pointer if none has been constructed yet.

void WebPage::endPage()

Emits any boilerplate to be emitted at the end of each page.

void WebPage::endParagraph()

As Output::endParagraph().

void WebPage::output( const String & s )

Write s to the output file.

void WebPage::startHeadline( Class * c )

As Output::startHeadline(). c is used to derive a file name.

void WebPage::startHeadline( Function * f )

As Output::startHeadline(). f is used to create an anchor.

void WebPage::startHeadline( Intro * i )

As Output::startHeadline(). i is used to derive a file name.

void WebPage::startPage( const String & name, const String & title )

Starts a new web page with base name name and title tag title. The title must not be empty per the HTML standard.

WebPage::~WebPage()

Destroys the web page object, flushing and closing the generated file.

This web page based on source code belonging to Oryx Mail Systems GmbH. All rights reserved.