Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 47 lines (35 sloc) 1.687 kB
3a46c43 @tomaz Refactored output generation by moving all specifics to OutputGenerat…
authored
1 //
2 // OutputProcessing.h
3 // appledoc
4 //
5 // Created by Tomaz Kragelj on 12.6.09.
6 // Copyright (C) 2009, Tomaz Kragelj. All rights reserved.
7 //
8
9 #import <Foundation/Foundation.h>
10
11 //////////////////////////////////////////////////////////////////////////////////////////
12 //////////////////////////////////////////////////////////////////////////////////////////
13 /** The @c OutputProcessing protocol defines methods that an output processing or
14 generating class must implement.
15
16 The methods consist of two groups. The main group is associated with the actual output
17 generation, while the helper group with additional tasks such as creating and removing
18 directories.
19 */
20 @protocol OutputProcessing
21
22 //////////////////////////////////////////////////////////////////////////////////////////
23 /// @name Output generation entry points
24 //////////////////////////////////////////////////////////////////////////////////////////
25
26 /** Notifies output generator to start processing the data and generate output.
27
28 This message is sent only to conformers which return @c YES from
29 @c isOutputGenerationEnabled(). The conformers which receive the message should process
30 it without having to check again. It is the responsibility of the clients to ensure that
31 this message is sent only if output generation is enabled.
32
33 @exception NSException Thrown if output generation fails.
34 @see isOutputGenerationEnabled
35 */
36 - (void) generateOutput;
37
38 /** Determines whether the specific output handled by conformer should be generated or not.
39
40 This answers the question "did user select the given output generation or not?".
41
42 @see generateOutput
43 */
44 @property(readonly) BOOL isOutputGenerationEnabled;
45
46 @end
Something went wrong with that request. Please try again.