Skip to content
Newer
Older
100644 208 lines (165 sloc) 7.27 KB
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
1 //
08bc173 @tomaz Renamed GeneratorBase to OutputGenerator and XHTMLGenerator to XHTMLO…
authored
2 // XHTMLOutputGenerator.h
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
3 // appledoc
4 //
5 // Created by Tomaz Kragelj on 28.5.09.
6 // Copyright (C) 2009, Tomaz Kragelj. All rights reserved.
7 //
8
3a46c43 @tomaz Refactored output generation by moving all specifics to OutputGenerat…
authored
9 #import "XMLBasedOutputGenerator.h"
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
10
11 //////////////////////////////////////////////////////////////////////////////////////////
12 //////////////////////////////////////////////////////////////////////////////////////////
3a46c43 @tomaz Refactored output generation by moving all specifics to OutputGenerat…
authored
13 /** Defines a concrete @c XMLBasedOutputGenerator that generates XHTML output.
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
14 */
3a46c43 @tomaz Refactored output generation by moving all specifics to OutputGenerat…
authored
15 @interface XHTMLOutputGenerator : XMLBasedOutputGenerator
afb0a1f @tomaz Implemented index output generation over the GeneratorBase.
authored
16 {
17 BOOL indexProtocolsGroupAppended;
18 BOOL indexCategoriesGroupAppended;
c4cf7ba @tomaz Implemented objects hierarchy output generation.
authored
19 NSString* hierarchyGroupIndent;
afb0a1f @tomaz Implemented index output generation over the GeneratorBase.
authored
20 }
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
21
22 //////////////////////////////////////////////////////////////////////////////////////////
afb0a1f @tomaz Implemented index output generation over the GeneratorBase.
authored
23 /// @name Object member helpers
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
24 //////////////////////////////////////////////////////////////////////////////////////////
25
2677c27 @tomaz Removed all unicode characters inserted by the doxygen custom user sc…
authored
26 /** Appends the given member title.
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
27
2677c27 @tomaz Removed all unicode characters inserted by the doxygen custom user sc…
authored
28 @param data The data to append to.
29 @param item The member item to get information from.
30 @exception NSException Thrown if appending fails.
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
31 */
3432bbd @tomaz Refactored output generator handling to allow index implementation.
authored
32 - (void) appendObjectMemberTitleToData:(NSMutableData*) data
33 fromItem:(id) item;
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
34
2677c27 @tomaz Removed all unicode characters inserted by the doxygen custom user sc…
authored
35 /** Appends the given member overview description.
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
36
2677c27 @tomaz Removed all unicode characters inserted by the doxygen custom user sc…
authored
37 @param data The data to append to.
38 @param item The member item to get information from.
39 @exception NSException Thrown if appending fails.
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
40 */
3432bbd @tomaz Refactored output generator handling to allow index implementation.
authored
41 - (void) appendObjectMemberOverviewToData:(NSMutableData*) data
42 fromItem:(id) item;
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
43
2677c27 @tomaz Removed all unicode characters inserted by the doxygen custom user sc…
authored
44 /** Appends the given member prototype description.
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
45
2677c27 @tomaz Removed all unicode characters inserted by the doxygen custom user sc…
authored
46 @param data The data to append to.
47 @param item The member item to get information from.
48 @exception NSException Thrown if appending fails.
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
49 */
3432bbd @tomaz Refactored output generator handling to allow index implementation.
authored
50 - (void) appendObjectMemberPrototypeToData:(NSMutableData*) data
51 fromItem:(id) item;
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
52
2677c27 @tomaz Removed all unicode characters inserted by the doxygen custom user sc…
authored
53 /** Appends the given member section type description.
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
54
55 The type should be one of the following:
afb0a1f @tomaz Implemented index output generation over the GeneratorBase.
authored
56 - @c kTKObjectMemberSectionParameters: The array of all parameters will be returned.
57 - @c kTKObjectMemberSectionExceptions: The array of all exceptions will be returned.
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
58
2677c27 @tomaz Removed all unicode characters inserted by the doxygen custom user sc…
authored
59 @param data The data to append to.
60 @param item The member item to get information from.
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
61 @param type The member section type.
62 @param title The desired section title.
2677c27 @tomaz Removed all unicode characters inserted by the doxygen custom user sc…
authored
63 @exception NSException Thrown if appending fails.
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
64 */
3432bbd @tomaz Refactored output generator handling to allow index implementation.
authored
65 - (void) appendObjectMemberSectionToData:(NSMutableData*) data
66 fromItem:(id) item
67 type:(int) type
68 title:(NSString*) title;
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
69
2677c27 @tomaz Removed all unicode characters inserted by the doxygen custom user sc…
authored
70 /** Appends the given member return description.
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
71
2677c27 @tomaz Removed all unicode characters inserted by the doxygen custom user sc…
authored
72 @param data The data to append to.
73 @param item The member item to get information from.
74 @exception NSException Thrown if appending fails.
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
75 */
3432bbd @tomaz Refactored output generator handling to allow index implementation.
authored
76 - (void) appendObjectMemberReturnToData:(NSMutableData*) data
77 fromItem:(id) item;
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
78
2677c27 @tomaz Removed all unicode characters inserted by the doxygen custom user sc…
authored
79 /** Appends the given member discussion description.
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
80
2677c27 @tomaz Removed all unicode characters inserted by the doxygen custom user sc…
authored
81 @param data The data to append to.
82 @param item The member item to get information from.
83 @exception NSException Thrown if appending fails.
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
84 */
3432bbd @tomaz Refactored output generator handling to allow index implementation.
authored
85 - (void) appendObjectMemberDiscussionToData:(NSMutableData*) data
86 fromItem:(id) item;
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
87
2677c27 @tomaz Removed all unicode characters inserted by the doxygen custom user sc…
authored
88 /** Appends the given member warning description.
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
89
2677c27 @tomaz Removed all unicode characters inserted by the doxygen custom user sc…
authored
90 @param data The data to append to.
91 @param item The member item to get information from.
92 @exception NSException Thrown if appending fails.
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
93 */
3432bbd @tomaz Refactored output generator handling to allow index implementation.
authored
94 - (void) appendObjectMemberWarningToData:(NSMutableData*) data
95 fromItem:(id) item;
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
96
2677c27 @tomaz Removed all unicode characters inserted by the doxygen custom user sc…
authored
97 /** Appends the given member bug description.
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
98
2677c27 @tomaz Removed all unicode characters inserted by the doxygen custom user sc…
authored
99 @param data The data to append to.
100 @param item The member item to get information from.
101 @exception NSException Thrown if appending fails.
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
102 */
3432bbd @tomaz Refactored output generator handling to allow index implementation.
authored
103 - (void) appendObjectMemberBugToData:(NSMutableData*) data
104 fromItem:(id) item;
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
105
2677c27 @tomaz Removed all unicode characters inserted by the doxygen custom user sc…
authored
106 /** Appends the given member see also section description.
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
107
2677c27 @tomaz Removed all unicode characters inserted by the doxygen custom user sc…
authored
108 @param data The data to append to.
109 @param item The member item to get information from.
110 @exception NSException Thrown if appending fails.
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
111 */
3432bbd @tomaz Refactored output generator handling to allow index implementation.
authored
112 - (void) appendObjectMemberSeeAlsoToData:(NSMutableData*) data
113 fromItem:(id) item;
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
114
2677c27 @tomaz Removed all unicode characters inserted by the doxygen custom user sc…
authored
115 /** Appends the given member declaration file description.
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
116
2677c27 @tomaz Removed all unicode characters inserted by the doxygen custom user sc…
authored
117 @param data The data to append to.
118 @param item The member item to get information from.
119 @exception NSException Thrown if appending fails.
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
120 */
3432bbd @tomaz Refactored output generator handling to allow index implementation.
authored
121 - (void) appendObjectMemberFileToData:(NSMutableData*) data
122 fromItem:(id) item;
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
123
124 //////////////////////////////////////////////////////////////////////////////////////////
125 /// @name Description helpers
126 //////////////////////////////////////////////////////////////////////////////////////////
127
2677c27 @tomaz Removed all unicode characters inserted by the doxygen custom user sc…
authored
128 /** Appends the brief description to the given data.
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
129
130 First the brief description is retreived from the given node, then the data from the
131 retreived nodes is converted to a proper XHTML format and is then appended to the end
132 of the given data.
133
2677c27 @tomaz Removed all unicode characters inserted by the doxygen custom user sc…
authored
134 @param data The data to append to.
135 @param item The description item which brief subcsection to append.
136 @exception NSException Thrown if appending fails.
3432bbd @tomaz Refactored output generator handling to allow index implementation.
authored
137 @see appendDetailedDescriptionToData:fromItem:
26c268f @tomaz Refactored description blocks documentation extraction.
authored
138 @see appendDescriptionToData:fromDescription:
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
139 */
140 - (void) appendBriefDescriptionToData:(NSMutableData*) data
3432bbd @tomaz Refactored output generator handling to allow index implementation.
authored
141 fromItem:(id) item;
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
142
2677c27 @tomaz Removed all unicode characters inserted by the doxygen custom user sc…
authored
143 /** Appends the detailed description to the given data.
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
144
145 First the detailed description is retreived from the given node, then the data from the
146 retreived nodes is converted to a proper XHTML format and is then appended to the end
147 of the given data.
148
2677c27 @tomaz Removed all unicode characters inserted by the doxygen custom user sc…
authored
149 @param data The data to append to.
150 @param item The description item which detailed subcsection to append.
151 @exception NSException Thrown if appending fails.
3432bbd @tomaz Refactored output generator handling to allow index implementation.
authored
152 @see appendBriefDescriptionToData:fromItem:
26c268f @tomaz Refactored description blocks documentation extraction.
authored
153 @see appendDescriptionToData:fromDescription:
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
154 */
155 - (void) appendDetailedDescriptionToData:(NSMutableData*) data
3432bbd @tomaz Refactored output generator handling to allow index implementation.
authored
156 fromItem:(id) item;
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
157
3432bbd @tomaz Refactored output generator handling to allow index implementation.
authored
158 /** Converts the description data from the given paragraph to proper XHTML format and
2677c27 @tomaz Removed all unicode characters inserted by the doxygen custom user sc…
authored
159 appends it to the given data.
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
160
3432bbd @tomaz Refactored output generator handling to allow index implementation.
authored
161 This method will take care of converting the source data to proper XHTML tags, including
162 computer code, paragraphs, links etc. Note that this is the only place where the original
163 data XML structure is exposed to the class.
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
164
165 @param data The data to append to.
0a190cf @tomaz Implemented XHTML bordered examples, warnings and bugs generation.
authored
166 @param item The description paragraph which data to convert. If @c nil nothing will happen.
2677c27 @tomaz Removed all unicode characters inserted by the doxygen custom user sc…
authored
167 @exception NSException Thrown if convertion fails.
0a190cf @tomaz Implemented XHTML bordered examples, warnings and bugs generation.
authored
168 @see appendBriefDescriptionToData:fromItem:
169 @see appendDetailedDescriptionToData:fromItem:
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
170 */
171 - (void) appendDescriptionToData:(NSMutableData*) data
23f72c5 @tomaz Fixed XHTML see also member section output and refined various smalle…
authored
172 fromDescriptionItem:(id) item;
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
173
afb0a1f @tomaz Implemented index output generation over the GeneratorBase.
authored
174 //////////////////////////////////////////////////////////////////////////////////////////
175 /// @name Helper methods
176 //////////////////////////////////////////////////////////////////////////////////////////
177
2677c27 @tomaz Removed all unicode characters inserted by the doxygen custom user sc…
authored
178 /** Appends HTML file header to the given data.
afb0a1f @tomaz Implemented index output generation over the GeneratorBase.
authored
179
180 The senders should provide the desired title and path and name of the linked stylesheet
181 file.
182
2677c27 @tomaz Removed all unicode characters inserted by the doxygen custom user sc…
authored
183 @param data The data to append to.
184 @param title The title to use for the header.
185 @param stylesheet The path and name of the linked stylesheet file.
186 @exception NSException Thrown if appending fails.
afb0a1f @tomaz Implemented index output generation over the GeneratorBase.
authored
187 @see appendFileFooterToData:withLastUpdated:andIndexLink:
188 */
189 - (void) appendFileHeaderToData:(NSMutableData*) data
190 withTitle:(NSString*) title
191 andStylesheet:(NSString*) stylesheet;
192
2677c27 @tomaz Removed all unicode characters inserted by the doxygen custom user sc…
authored
193 /** Appends HTML file footer to the given data.
afb0a1f @tomaz Implemented index output generation over the GeneratorBase.
authored
194
195 The senders can optionally include last update time and back to index link.
196
2677c27 @tomaz Removed all unicode characters inserted by the doxygen custom user sc…
authored
197 @param data The data to append to.
198 @param showLastUpdate If @c YES, last updated time should be inserted.
199 @param showBackToIndex If @c YES, the link back to index should be inserted.
200 @exception NSException Thrown if appending fails.
afb0a1f @tomaz Implemented index output generation over the GeneratorBase.
authored
201 @see appendFileHeaderToData:withTitle:andStylesheet:
202 */
203 - (void) appendFileFooterToData:(NSMutableData*) data
204 withLastUpdated:(BOOL) showLastUpdate
205 andIndexLink:(BOOL) showBackToIndex;
206
4a74e35 @tomaz Updated HTML generation from using a XSLT stylesheet to custom conver…
authored
207 @end
Something went wrong with that request. Please try again.