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

Overview

Concrete GBOutputGenerator that installs generated documentation set files to Xcode.

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 -> GBDocSetInstallGenerator.m

outputUserPath

Returns the output path including outputSubpath.

- (NSString *)outputUserPath

Discussion

This uses the same string as entered by the user when starting the application. Send stringByStandardizingPath message to the returned value before using it!

Declared In

GBOutputGenerator.h@176 -> GBDocSetInstallGenerator.m