tomaz / appledoc

Objective-c code Apple style documentation generation. Based on Matt Ball's doxyclean.

This URL has Read+Write access

appledoc / XMLBasedOutputGenerator+IndexSubclassAPI.m
100644 71 lines (58 sloc) 2.312 kb
raw blame history 
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

//
//  XMLBasedOutputGenerator+IndexSubclassAPI.m
//  appledoc
//
//  Created by Tomaz Kragelj on 28.5.09.
//  Copyright (C) 2009, Tomaz Kragelj. All rights reserved.
//
 
#import "XMLBasedOutputGenerator+IndexSubclassAPI.h"
#import "DoxygenConverter.h"
 
@implementation XMLBasedOutputGenerator (IndexSubclassAPI)
 
//////////////////////////////////////////////////////////////////////////////////////////
#pragma mark File header and footer handling
//////////////////////////////////////////////////////////////////////////////////////////
 
//----------------------------------------------------------------------------------------
- (void) appendIndexHeaderToData:(NSMutableData*) data
{
}
 
//----------------------------------------------------------------------------------------
- (void) appendIndexFooterToData:(NSMutableData*) data
{	
}
 
//////////////////////////////////////////////////////////////////////////////////////////
#pragma mark Group handling
//////////////////////////////////////////////////////////////////////////////////////////
 
//----------------------------------------------------------------------------------------
- (void) appendIndexGroupHeaderToData:(NSMutableData*) data
								 type:(int) type
{
}
 
//----------------------------------------------------------------------------------------
- (void) appendIndexGroupFooterToData:(NSMutableData*) data
								 type:(int) type
{
}
 
//----------------------------------------------------------------------------------------
- (void) appendIndexGroupItemToData:(NSMutableData*) data
						   fromItem:(id) item
							  index:(int) index
							   type:(int) type
{
}
 
//////////////////////////////////////////////////////////////////////////////////////////
#pragma mark Properties
//////////////////////////////////////////////////////////////////////////////////////////
 
//----------------------------------------------------------------------------------------
- (NSString*) indexTitle
{
	NSString* project =
		(self.projectName != nil && [self.projectName length] > 0) ?
		self.projectName : @"Project";
	return [NSString stringWithFormat:@"%@ reference", project];
}
 
//----------------------------------------------------------------------------------------
- (NSXMLDocument*) indexMarkup
{
	return indexMarkup;
}
 
@end