public
Description: Objective-c code Apple style documentation generation. Based on Matt Ball's doxyclean.
Homepage: http://gentlebytes.com
Clone URL: git://github.com/tomaz/appledoc.git
appledoc / XMLBasedOutputGenerator+ObjectParsingAPI.m
100644 201 lines (174 sloc) 6.904 kb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
//
// XMLBasedOutputGenerator+ObjectParsingAPI.m
// appledoc
//
// Created by Tomaz Kragelj on 28.5.09.
// Copyright (C) 2009, Tomaz Kragelj. All rights reserved.
//
 
#import "XMLBasedOutputGenerator+GeneralParsingAPI.h"
#import "XMLBasedOutputGenerator+ObjectParsingAPI.h"
#import "DoxygenConverter.h"
 
@implementation XMLBasedOutputGenerator (ObjectParsingAPI)
 
//////////////////////////////////////////////////////////////////////////////////////////
#pragma mark Info items parsing support
//////////////////////////////////////////////////////////////////////////////////////////
 
//----------------------------------------------------------------------------------------
- (NSString*) extractObjectInfoItemRef:(id) item
{
NSXMLNode* idAttr = [item attributeForName:@"id"];
if (idAttr) return [idAttr stringValue];
return nil;
}
 
//----------------------------------------------------------------------------------------
- (NSString*) extractObjectInfoItemValue:(id) item
{
return [item stringValue];
}
 
//////////////////////////////////////////////////////////////////////////////////////////
#pragma mark Section parsing support
//////////////////////////////////////////////////////////////////////////////////////////
 
//----------------------------------------------------------------------------------------
- (NSString*) extractObjectTaskName:(id) item
{
NSXMLElement* nameNode = [self extractSubitemFromItem:item withName:@"name"];
if (nameNode) return [nameNode stringValue];
return nil;
}
 
//////////////////////////////////////////////////////////////////////////////////////////
#pragma mark Members parsing support
//////////////////////////////////////////////////////////////////////////////////////////
 
//----------------------------------------------------------------------------------------
- (int) extractObjectMemberType:(id) node
{
NSXMLNode* kindAttr = [node attributeForName:@"kind"];
if (kindAttr)
{
if ([[kindAttr stringValue] isEqualToString:@"class-method"])
return kTKObjectMemberTypeClass;
if ([[kindAttr stringValue] isEqualToString:@"instance-method"])
return kTKObjectMemberTypeInstance;
}
return kTKObjectMemberTypeProperty;
}
 
//----------------------------------------------------------------------------------------
- (NSString*) extractObjectMemberName:(id) node
{
NSXMLElement* nameNode = [self extractSubitemFromItem:node withName:@"name"];
if (nameNode) return [nameNode stringValue];
return nil;
}
 
//----------------------------------------------------------------------------------------
- (NSString*) extractObjectMemberSelector:(id) node
{
NSXMLElement* selectorNode = [self extractSubitemFromItem:node withName:@"selector"];
if (selectorNode) return [selectorNode stringValue];
return [self extractObjectMemberName:node];
}
 
//----------------------------------------------------------------------------------------
- (NSString*) extractObjectMemberFile:(id) node
{
NSXMLElement* fileNode = [self extractSubitemFromItem:node withName:@"file"];
if (fileNode) return [fileNode stringValue];
return nil;
}
 
//----------------------------------------------------------------------------------------
- (id) extractObjectMemberPrototypeItem:(id) node
{
return [self extractSubitemFromItem:node withName:@"prototype"];
}
 
//----------------------------------------------------------------------------------------
- (id) extractObjectMemberDescriptionItem:(id) node
{
return [self extractSubitemFromItem:node withName:@"description"];
}
 
//----------------------------------------------------------------------------------------
- (NSArray*) extractObjectMemberSectionItems:(id) node
type:(int) type
{
NSString* query = nil;
switch (type)
{
case kTKObjectMemberSectionExceptions:
query = @"exceptions/param";
break;
default:
query = @"parameters/param";
break;
}
NSArray* result = [node nodesForXPath:query error:nil];
if ([result count] > 0) return result;
return nil;
}
 
//----------------------------------------------------------------------------------------
- (id) extractObjectMemberReturnItem:(id) node
{
return [self extractSubitemFromItem:node withName:@"return"];
}
 
//----------------------------------------------------------------------------------------
- (id) extractObjectMemberWarningItem:(id) node
{
return [self extractSubitemFromItem:node withName:@"warning"];
}
 
//----------------------------------------------------------------------------------------
- (id) extractObjectMemberBugItem:(id) node
{
return [self extractSubitemFromItem:node withName:@"bug"];
}
 
//----------------------------------------------------------------------------------------
- (NSArray*) extractObjectMemberSeeAlsoItems:(id) node
{
// Get all see also items, then make sure <ref> subnodes are properly handled.
NSArray* itemNodes = [node nodesForXPath:@"seeAlso/item" error:nil];
if ([itemNodes count] > 0)
{
NSMutableArray* result = [NSMutableArray array];
for (NSXMLNode* itemNode in itemNodes)
{
NSArray* refNodes = [itemNode nodesForXPath:@"ref" error:nil];
if ([refNodes count] > 0)
{
[result addObject:[refNodes objectAtIndex:0]];
continue;
}
[result addObject:itemNode];
}
return result;
}
return nil;
}
 
//////////////////////////////////////////////////////////////////////////////////////////
#pragma mark Member prototype parsing support
//////////////////////////////////////////////////////////////////////////////////////////
 
//----------------------------------------------------------------------------------------
- (NSArray*) extractObjectMemberPrototypeSubitems:(id) node
{
return [node children];
}
 
//----------------------------------------------------------------------------------------
- (int) extractObjectMemberPrototypeItemType:(id) item
{
NSXMLNode* node = (NSXMLNode*)item;
if ([node kind] == NSXMLElementKind) return kTKObjectMemberPrototypeParameter;
return kTKObjectMemberPrototypeValue;
}
 
//----------------------------------------------------------------------------------------
- (NSString*) extractObjectMemberPrototypeItemValue:(id) item
{
return [item stringValue];
}
 
//////////////////////////////////////////////////////////////////////////////////////////
#pragma mark Parameter parsing support
//////////////////////////////////////////////////////////////////////////////////////////
 
//----------------------------------------------------------------------------------------
- (NSString*) extractObjectParameterName:(id) node
{
NSXMLElement* nameNode = [self extractSubitemFromItem:node withName:@"name"];
if (nameNode) return [nameNode stringValue];
return nil;
}
 
//----------------------------------------------------------------------------------------
- (id) extractObjectParameterDescriptionItem:(id) node
{
return [self extractSubitemFromItem:node withName:@"description"];
}
 
@end