DocGenerator/DocCDataType.h at master · etoile/DocGenerator · GitHub

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
/**
	<abstract>C data types in the doc element tree.</abstract>

	Copyright (C) 2010 Quentin Mathe

	Author:  Quentin Mathe <quentin.mathe@gmail.com>
	Date:  November 2010
	License:  Modified BSD (see COPYING)
 */

#import <Foundation/Foundation.h>
#import <EtoileFoundation/EtoileFoundation.h>
#import <SourceCodeKit/SourceCodeKit.h>
#import "DocElement.h"
#import "GSDocParser.h"

/**
@group Doc Element Tree

DocCDataType objects are used to represent various C data types:

<list>
<item>structure</item>
<item>function pointer</item>
</list>

Enum and union are represented with DocConstant -weaveSelector. */
@interface DocCDataType : DocElement <GSDocParserDelegate>
{
	NSString *type;
}

/** The underlying type such as struct, enum, NSString const * etc. */
@property (strong, nonatomic) NSString * type;
/** Returns whether the current -type is constant-like. e.g. enum or union. */
@property (readonly) BOOL isConstant;

/** @taskunit GSDoc Parsing */

/** <override-dummy />
Returns <em>type</em>.

See -[DocElement GSDocElementName]. */
- (NSString *) GSDocElementName;
/** <override-dummy />
Returns -weaveOtherDataType:.

See -[DocElement weaveSelector]. */
- (SEL) weaveSelector;

@end

/** @group Doc Element Tree
@abstract Global variables in the doc element tree.

DocVariable objects are used to represent global variables not declared as
constants (in that DocConstant would be used). */
@interface DocVariable : DocCDataType
{

}

/** @taskunit GSDoc Parsing */

/** <override-dummy />
Returns <em>variable</em>.

See -[DocElement GSDocElementName]. */
- (NSString *) GSDocElementName;
/** <override-dummy />
Returns -weaveConstant:.

See -[DocElement weaveSelector]. */
- (SEL) weaveSelector;

- (void) parseProgramComponent: (SCKGlobal *)aGlobal;

@end


/** @group Doc Element Tree
@abstract C constant-like types in the doc element tree.

DocConstant objects are used to represent various constant-like C data types:

<list>
<item>const variable or pointer</item>
<item>enum</item>
<item>union</item>
</list>  */
@interface DocConstant : DocCDataType
{

}

/** @taskunit GSDoc Parsing */

/** <override-dummy />
Returns <em>constant</em>.

See -[DocElement GSDocElementName]. */
- (NSString *) GSDocElementName;
/** <override-dummy />
Returns -weaveConstant:.

See -[DocElement weaveSelector]. */
- (SEL) weaveSelector;

/* Constant can be enum or union and each of them has different
 * class in SCK. So id should be used as parameter, not DocConstant.
 */
- (void)parseProgramComponent: (id)aConstant;

@end