Inherits from GBOutputGenerator : NSObject
Declared in GBDocSetOutputGenerator.h
GBDocSetOutputGenerator.m

Overview

Concrete GBOutputGenerator that generates documentation set files.

Tasks

Instance Methods

generateOutputWithStore:error:

Generates the output at the proper subdirectory of the output path as defined in assigned settings.

- (BOOL)generateOutputWithStore:(id)store error:(NSError **)error

Parameters

store
The GBStore object that holds the store with all parsed and processed data.
error
If generation fails, error description is returned here.

Discussion

This is the most important method of the GBOutputGenerator class. It generates all required output. It is intended to be overriden in subclasses. Default implementation assigns the given store and returns YES. Subclasses must call super class implementation before anything else!

Declared In

GBOutputGenerator.h@97 -> GBDocSetOutputGenerator.m

outputSubpath

Returns the path relative to main output path, where all generated data is stored.

- (NSString *)outputSubpath

Discussion

At the same this, this also defines the path relative to main templates path, where all template files for this output generator are stored. Default implementation simply returns empty string, each subclass is supposed to override and return prover value.

Declared In

GBOutputGenerator.h@201 -> GBDocSetOutputGenerator.m