| Declared in | GBApplicationSettingsProviding.h |
Defines the requirements for application-level settings providers.
Application-level settings providers provide application-wide settings and properties that affect application handling.
templatesPath
The base path to template files used for generating various output files.
required method
cssClassTemplatePath
The path to the CSS template file, relative from class html files.
required method
cssCategoryTemplatePath
The path to the CSS template file, relative from category html files.
required method
cssProtocolTemplatePath
The path to the CSS template file, relative from protocol html files.
required method
cssIndexTemplatePath
The path to the CSS template file, relative from index html files.
required method
outputPath
The base path of the generated files.
required method
htmlOutputPath
The base path of the HTML generated files.
required method
- htmlOutputPathForObject:
Returns file name including full path for HTML file representing the given top-level object.
required method
- htmlOutputPathForIndex
Returns file name including full path for HTML file representing the main index.
required method
- htmlReferenceNameForObject:
Returns HTML reference name for the given object.
required method
- htmlReferenceForObject:fromSource:
Returns relative HTML reference to the given object from the context of the given source object.
required method
ignoredPaths
The list of all full or partial paths to be ignored.
required method
commentComponents
Returns the GBCommentComponentsProvider object that identifies comment components.
required method
stringTemplates
Returns the GBApplicationStringsProvider object that specifies all string templates used for output generation.
required method
Returns file name including full path for HTML file representing the main index.
- (NSString *)htmlOutputPathForIndexReturns the path.
Returns file name including full path for HTML file representing the main index.
GBApplicationSettingsProviding.hReturns file name including full path for HTML file representing the given top-level object.
- (NSString *)htmlOutputPathForObject:(GBModelBase *)objectReturns the path.
Returns file name including full path for HTML file representing the given top-level object.
This works for any top-level object: class, category or protocol. The path is automatically determined regarding to the object class.
nil or not top-level object. GBApplicationSettingsProviding.hReturns relative HTML reference to the given object from the context of the given source object.
- (NSString *)htmlReferenceForObject:(GBModelBase *)object fromSource:(GBModelBase *)source nil for index to object reference. Returns the reference string.
Returns relative HTML reference to the given object from the context of the given source object.
This is useful for generating hrefs from one object HTML file to another. This is the swiss army knife king of a method for all hrefs generation. It works for any kind of links:
nil ). nil ). nil . GBApplicationSettingsProviding.hReturns HTML reference name for the given object.
- (NSString *)htmlReferenceNameForObject:(GBModelBase *)objectReturns the reference name of the object.
Returns HTML reference name for the given object.
This should only be used for creating anchors that need to be referenced from other parts of the same HTML file. The method works for top-level objects as well as their members.
nil . GBApplicationSettingsProviding.h Returns the GBCommentComponentsProvider object that identifies comment components.
@property (retain) GBCommentComponentsProvider *commentComponents Returns the GBCommentComponentsProvider object that identifies comment components.
GBApplicationSettingsProviding.hThe path to the CSS template file, relative from category html files.
@property (readonly) NSString *cssCategoryTemplatePathThe path to the CSS template file, relative from category html files.
GBApplicationSettingsProviding.hThe path to the CSS template file, relative from class html files.
@property (readonly) NSString *cssClassTemplatePathThe path to the CSS template file, relative from class html files.
GBApplicationSettingsProviding.hThe path to the CSS template file, relative from index html files.
@property (readonly) NSString *cssIndexTemplatePathThe path to the CSS template file, relative from index html files.
GBApplicationSettingsProviding.hThe path to the CSS template file, relative from protocol html files.
@property (readonly) NSString *cssProtocolTemplatePathThe path to the CSS template file, relative from protocol html files.
GBApplicationSettingsProviding.hThe base path of the HTML generated files.
@property (readonly) NSString *htmlOutputPathThe base path of the HTML generated files.
This value depends on outputPath and is automatically calculated.
GBApplicationSettingsProviding.hThe list of all full or partial paths to be ignored.
@property (retain) NSMutableArray *ignoredPathsThe list of all full or partial paths to be ignored.
It's recommended to check if a path string ends with any of the given paths before processing it. This should catch directory and file names properly as directories are processed first.
GBApplicationSettingsProviding.hThe base path of the generated files.
@property (copy) NSString *outputPathThe base path of the generated files.
GBApplicationSettingsProviding.h Returns the GBApplicationStringsProvider object that specifies all string templates used for output generation.
@property (retain) GBApplicationStringsProvider *stringTemplates Returns the GBApplicationStringsProvider object that specifies all string templates used for output generation.
GBApplicationSettingsProviding.h