Class Output.

Inherits Garbage

The Output class coordinates documentation output.

It provides a number of static functions, each of which calls eponymous functions in each of the concrete output classes. The only output class currently is WebPage. PostScript and ManPage may be written when arnt is bored or they seem useful.

static void Output::addArgument( const String & text )

Adds text as an argument name to all output devices.

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

Adds a link to c titled text on all output devices. Each device may express the link differently.

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

Adds a link to f titled text on all output devices. Each device may express the link differently.

static void Output::addLink( const String & url, const String & title )

Adds url and title as a link to all capable output devices.

static void Output::addSpace()

Adds a single space to all output devices, prettily optimizing so there aren't lots of spaces where none are needed.

static void Output::addText( const String & text )

Adds text as ordinary text to all output devices.

static void Output::endParagraph()

Ends the current paragraph on all output devices.

static String Output::owner()

Returns the owner string, or an empty string if none has been set.

static String Output::ownerHome()

Returns the URL of the rights owner, or an empty string if none has been set.

static void Output::setOwner( const String & owner )

Remembers that owner is the owner of the input. Most output will carry the name.

static void Output::setOwnerHome( const String & url )

Remembers that url is the home page of the rights owner. Most output will link to or mention url.

static void Output::startHeadline( Class * c )

Starts a headline for c, with appropriate fonts etc. The headline runs until endParagraph() is called.

static void Output::startHeadline( Function * f )

Starts a headline for f, with appropriate fonts etc. The headline runs until endParagraph() is called.

static void Output::startHeadline( Intro * i )

Starts a headline for i, with appropriate fonts etc. The headline runs until endParagraph() is called.

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