Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 103 lines (82 sloc) 3.377 kB
3a46c43 @tomaz Refactored output generation by moving all specifics to OutputGenerat…
authored
1 //
2 // OutputInfoProvider.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 OutputInfoProvider protocol defines methods that objects which need to
14 provide information about their output must implement.
15
16 The main argument for this interface is to decouple concrete @c OutputGenerator classes
17 from their dependent output generators. For example documentation set generator needs to
18 know the names and extensions used by the XHTML output generator. However to allow
19 arbitrary HTML output generator to be used with documentation set, the documentation set
20 output generator needs any object that conforms to @c OutputInfoProvider so that it
21 can get all required information it needs.
22 */
23 @protocol OutputInfoProvider
24
25 //////////////////////////////////////////////////////////////////////////////////////////
26 /// @name Output information providing
27 //////////////////////////////////////////////////////////////////////////////////////////
28
29 /** Returns the given object file name.
30
31 @param objectData The @c NSDictionary from main database representing the object data.
32 @return Returns the given object file name, including relative path from the base
33 directory and extension.
34 @see outputIndexFilename
35 @see outputHierarchyFilename
36 @see outputFilesExtension
fd65a45 @tomaz Fixed output generator directory dependencies handling.
authored
37 @see outputBasePath
3a46c43 @tomaz Refactored output generation by moving all specifics to OutputGenerat…
authored
38 */
39 - (NSString*) outputObjectFilenameForObject:(NSDictionary*) objectData;
40
41 /** Returns the index file name.
42
43 @return Returns the index file name, including relative path from the base directory and
44 extension.
45 @see outputObjectFilenameForObject:
46 @see outputHierarchyFilename
47 @see outputFilesExtension
fd65a45 @tomaz Fixed output generator directory dependencies handling.
authored
48 @see outputBasePath
3a46c43 @tomaz Refactored output generation by moving all specifics to OutputGenerat…
authored
49 */
50 - (NSString*) outputIndexFilename;
51
52 /** Returns the hierarchy file name.
53
54 @return Returns the hierarchy file name, including relative path from the base directory
55 and extension.
56 @see outputObjectFilenameForObject:
57 @see outputIndexFilename
58 @see outputFilesExtension
fd65a45 @tomaz Fixed output generator directory dependencies handling.
authored
59 @see outputBasePath
3a46c43 @tomaz Refactored output generation by moving all specifics to OutputGenerat…
authored
60 */
61 - (NSString*) outputHierarchyFilename;
62
63 /** Returns the output files extension.
64
329b067 @tomaz Added extra reference extension option for concrete OutputGenerators.
authored
65 Output file extension is added to all generated output files.
66
fd65a45 @tomaz Fixed output generator directory dependencies handling.
authored
67 @return Returns the output files extension.
329b067 @tomaz Added extra reference extension option for concrete OutputGenerators.
authored
68 @see outputReferencesExtension
3a46c43 @tomaz Refactored output generation by moving all specifics to OutputGenerat…
authored
69 @see outputObjectFilenameForObject:
70 @see outputIndexFilename
71 @see outputHierarchyFilename
fd65a45 @tomaz Fixed output generator directory dependencies handling.
authored
72 @see outputBasePath
3a46c43 @tomaz Refactored output generation by moving all specifics to OutputGenerat…
authored
73 */
74 - (NSString*) outputFilesExtension;
75
329b067 @tomaz Added extra reference extension option for concrete OutputGenerators.
authored
76 /** Returns the output references extension.
77
78 References extension is used while generating the references inside output files. In]
79 most cases this should be the same as @c outputFilesExtension().
80
81 @return Returns the references files extension.
82 @see outputFilesExtension
83 @see outputObjectFilenameForObject:
84 @see outputIndexFilename
85 @see outputHierarchyFilename
86 @see outputBasePath
87 */
88 - (NSString*) outputReferencesExtension;
89
fd65a45 @tomaz Fixed output generator directory dependencies handling.
authored
90 /** Returns the base path where output files are generated.
6149a66 @tomaz Reorganized output paths generation by moving common code to the Outp…
authored
91
92 This is full path to the base directory under which all files are generated.
fd65a45 @tomaz Fixed output generator directory dependencies handling.
authored
93
94 @return Returns the base path where output files are generated.
95 @see outputObjectFilenameForObject:
96 @see outputIndexFilename
97 @see outputHierarchyFilename
98 @see outputFilesExtension
99 */
100 - (NSString*) outputBasePath;
101
3a46c43 @tomaz Refactored output generation by moving all specifics to OutputGenerat…
authored
102 @end
Something went wrong with that request. Please try again.