DocGenerator/DocMacro.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
/**
	<abstract>Macros in the doc element tree.</abstract>

	Copyright (C) 2010 Quentin Mathe

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

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

@class DocHTMLElement;

/** @group Doc Element Tree

A DocMacro object represents a macro in the documentation element tree. */
@interface DocMacro : DocFunction
{

}

/** @taskunit GSDoc Parsing */

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

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

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

- (void) parseProgramComponent: (SCKMacro *)aMacro;

@end