XHTMLOutputGenerator class reference

Inherits from	XMLBasedOutputGenerator : OutputGenerator : NSObject
Declared in	XHTMLOutputGenerator.h

Overview

Defines a concrete XMLBasedOutputGenerator that generates XHTML output.

Tasks

Object member helpers

- appendObjectMemberTitleToData:fromItem: Appends the given member title.
- appendObjectMemberOverviewToData:fromItem: Appends the given member overview description.
- appendObjectMemberPrototypeToData:fromItem: Appends the given member prototype description.
- appendObjectMemberSectionToData:fromItem:type:title: Appends the given member section type description.
- appendObjectMemberReturnToData:fromItem: Appends the given member return description.
- appendObjectMemberDiscussionToData:fromItem: Appends the given member discussion description.
- appendObjectMemberWarningToData:fromItem: Appends the given member warning description.
- appendObjectMemberBugToData:fromItem: Appends the given member bug description.
- appendObjectMemberSeeAlsoToData:fromItem: Appends the given member see also section description.
- appendObjectMemberFileToData:fromItem: Appends the given member declaration file description.

Description helpers

- appendBriefDescriptionToData:fromItem: Appends the brief description to the given data.
- appendDetailedDescriptionToData:fromItem: Appends the detailed description to the given data.
- appendDescriptionToData:fromDescriptionItem: Converts the description data from the given paragraph to proper XHTML format and appends it to the given data.

Helper methods

- appendFileHeaderToData:withTitle:andStylesheet: Appends HTML file header to the given data.
- appendFileFooterToData:withLastUpdated:andIndexLink: Appends HTML file footer to the given data.

Instance methods

appendObjectMemberTitleToData:fromItem:

Appends the given member title.

- (void)appendObjectMemberTitleToData:(NSMutableData *)        data
 fromItem:(id)        item

Parameters

data: The data to append to.
item: The member item to get information from.

Exceptions

NSException: Thrown if appending fails.

Declared in

XHTMLOutputGenerator.h

appendObjectMemberOverviewToData:fromItem:

Appends the given member overview description.

- (void)appendObjectMemberOverviewToData:(NSMutableData *)        data
 fromItem:(id)        item

Parameters

data: The data to append to.
item: The member item to get information from.

Exceptions

NSException: Thrown if appending fails.

Declared in

XHTMLOutputGenerator.h

appendObjectMemberPrototypeToData:fromItem:

Appends the given member prototype description.

- (void)appendObjectMemberPrototypeToData:(NSMutableData *)        data
 fromItem:(id)        item

Parameters

data: The data to append to.
item: The member item to get information from.

Exceptions

NSException: Thrown if appending fails.

Declared in

XHTMLOutputGenerator.h

appendObjectMemberSectionToData:fromItem:type:title:

Appends the given member section type description.

- (void)appendObjectMemberSectionToData:(NSMutableData *)        data
 fromItem:(id)        item
 type:(int)        type
 title:(NSString *)        title

Parameters

data: The data to append to.
item: The member item to get information from.
type: The member section type.
title: The desired section title.

Exceptions

NSException: Thrown if appending fails.

Discussion

The type should be one of the following:

kTKObjectMemberSectionParameters: The array of all parameters will be returned.
kTKObjectMemberSectionExceptions: The array of all exceptions will be returned.

Declared in

XHTMLOutputGenerator.h

appendObjectMemberReturnToData:fromItem:

Appends the given member return description.

- (void)appendObjectMemberReturnToData:(NSMutableData *)        data
 fromItem:(id)        item

Parameters

data: The data to append to.
item: The member item to get information from.

Exceptions

NSException: Thrown if appending fails.

Declared in

XHTMLOutputGenerator.h

appendObjectMemberDiscussionToData:fromItem:

Appends the given member discussion description.

- (void)appendObjectMemberDiscussionToData:(NSMutableData *)        data
 fromItem:(id)        item

Parameters

data: The data to append to.
item: The member item to get information from.

Exceptions

NSException: Thrown if appending fails.

Declared in

XHTMLOutputGenerator.h

appendObjectMemberWarningToData:fromItem:

Appends the given member warning description.

- (void)appendObjectMemberWarningToData:(NSMutableData *)        data
 fromItem:(id)        item

Parameters

data: The data to append to.
item: The member item to get information from.

Exceptions

NSException: Thrown if appending fails.

Declared in

XHTMLOutputGenerator.h

appendObjectMemberBugToData:fromItem:

Appends the given member bug description.

- (void)appendObjectMemberBugToData:(NSMutableData *)        data
 fromItem:(id)        item

Parameters

data: The data to append to.
item: The member item to get information from.

Exceptions

NSException: Thrown if appending fails.

Declared in

XHTMLOutputGenerator.h

appendObjectMemberSeeAlsoToData:fromItem:

Appends the given member see also section description.

- (void)appendObjectMemberSeeAlsoToData:(NSMutableData *)        data
 fromItem:(id)        item

Parameters

data: The data to append to.
item: The member item to get information from.

Exceptions

NSException: Thrown if appending fails.

Declared in

XHTMLOutputGenerator.h

appendObjectMemberFileToData:fromItem:

Appends the given member declaration file description.

- (void)appendObjectMemberFileToData:(NSMutableData *)        data
 fromItem:(id)        item

Parameters

data: The data to append to.
item: The member item to get information from.

Exceptions

NSException: Thrown if appending fails.

Declared in

XHTMLOutputGenerator.h

appendBriefDescriptionToData:fromItem:

Appends the brief description to the given data.

- (void)appendBriefDescriptionToData:(NSMutableData *)        data
 fromItem:(id)        item

Parameters

data: The data to append to.
item: The description item which brief subcsection to append.

Exceptions

NSException: Thrown if appending fails.

Discussion

First the brief description is retreived from the given node, then the data from the retreived nodes is converted to a proper XHTML format and is then appended to the end of the given data.

Declared in

XHTMLOutputGenerator.h

appendDetailedDescriptionToData:fromItem:

Appends the detailed description to the given data.

- (void)appendDetailedDescriptionToData:(NSMutableData *)        data
 fromItem:(id)        item

Parameters

data: The data to append to.
item: The description item which detailed subcsection to append.

Exceptions

NSException: Thrown if appending fails.

Discussion

First the detailed description is retreived from the given node, then the data from the retreived nodes is converted to a proper XHTML format and is then appended to the end of the given data.

Declared in

XHTMLOutputGenerator.h

appendDescriptionToData:fromDescriptionItem:

Converts the description data from the given paragraph to proper XHTML format and appends it to the given data.

- (void)appendDescriptionToData:(NSMutableData *)        data
 fromDescriptionItem:(id)        item

Parameters

data: The data to append to.
item: The description paragraph which data to convert. If nil nothing will happen.

Exceptions

NSException: Thrown if convertion fails.

Discussion

This method will take care of converting the source data to proper XHTML tags, including computer code, paragraphs, links etc. Note that this is the only place where the original data XML structure is exposed to the class.

Declared in

XHTMLOutputGenerator.h

appendFileHeaderToData:withTitle:andStylesheet:

Appends HTML file header to the given data.

- (void)appendFileHeaderToData:(NSMutableData *)        data
 withTitle:(NSString *)        title
 andStylesheet:(NSString *)        stylesheet

Parameters

data: The data to append to.
title: The title to use for the header.
stylesheet: The path and name of the linked stylesheet file.

Exceptions

NSException: Thrown if appending fails.

Discussion

The senders should provide the desired title and path and name of the linked stylesheet file.

Declared in

XHTMLOutputGenerator.h

appendFileFooterToData:withLastUpdated:andIndexLink:

Appends HTML file footer to the given data.

- (void)appendFileFooterToData:(NSMutableData *)        data
 withLastUpdated:(BOOL)        showLastUpdate
 andIndexLink:(BOOL)        showBackToIndex

Parameters

data: The data to append to.
showLastUpdate: If YES, last updated time should be inserted.
showBackToIndex: If YES, the link back to index should be inserted.

Exceptions

NSException: Thrown if appending fails.

Discussion

The senders can optionally include last update time and back to index link.

Declared in

XHTMLOutputGenerator.h

XHTMLOutputGenerator class reference

Overview

Tasks

Object member helpers

Description helpers

Helper methods

Instance methods

appendObjectMemberTitleToData:fromItem:

Parameters

Exceptions

Declared in

appendObjectMemberOverviewToData:fromItem:

Parameters

Exceptions

Declared in

appendObjectMemberPrototypeToData:fromItem:

Parameters

Exceptions

Declared in

appendObjectMemberSectionToData:fromItem:type:title:

Parameters

Exceptions

Discussion

Declared in

appendObjectMemberReturnToData:fromItem:

Parameters

Exceptions

Declared in

appendObjectMemberDiscussionToData:fromItem:

Parameters

Exceptions

Declared in

appendObjectMemberWarningToData:fromItem:

Parameters

Exceptions

Declared in

appendObjectMemberBugToData:fromItem:

Parameters

Exceptions

Declared in

appendObjectMemberSeeAlsoToData:fromItem:

Parameters

Exceptions

Declared in

appendObjectMemberFileToData:fromItem:

Parameters

Exceptions

Declared in

appendBriefDescriptionToData:fromItem:

Parameters

Exceptions

Discussion

See also

Declared in

appendDetailedDescriptionToData:fromItem:

Parameters

Exceptions

Discussion

See also

Declared in

appendDescriptionToData:fromDescriptionItem:

Parameters

Exceptions

Discussion

See also

Declared in

appendFileHeaderToData:withTitle:andStylesheet:

Parameters

Exceptions

Discussion

See also

Declared in

appendFileFooterToData:withLastUpdated:andIndexLink:

Parameters

Exceptions

Discussion

See also

Declared in