Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 62 lines (45 sloc) 2.269 kb
42d1cf7 @tomaz Implemented method arguments registration and processing.
authored
1 //
2 // GBCommentArgument.h
3 // appledoc
4 //
5 // Created by Tomaz Kragelj on 16.2.11.
6 // Copyright 2011 Gentle Bytes. All rights reserved.
7 //
8
9 #import <Foundation/Foundation.h>
10
11 @class GBCommentComponentsList;
12 @class GBSourceInfo;
13
14 /** Handles individual `GBComment` named argument.
15
16 A comment argument is either a parameter or exception. In any case, the class allows assigning argument name and description. The description is simply a list of comment components in the form of `GBCommentComponentsList`. This allows every parameter contain arbitrary descriptions!
17 */
18 @interface GBCommentArgument : NSObject
19
20 ///---------------------------------------------------------------------------------------
21 /// @name Initialization & disposal
22 ///---------------------------------------------------------------------------------------
23
24 /** Returns a new autoreleased instance of the object with the given string value.
25
26 This is a helper initializer which allows setting name with a single message. Sending this message is equivalent to sending `argumentWithName:sourceInfo:`, passing the given _value_ and `nil` for source info.
27
28 @param name Name of the argument.
29 @return Returns initialized object or `nil` if initialization fails.
30 @see argumentWithName:sourceInfo:
31 */
32 + (id)argumentWithName:(NSString *)name;
33
34 /** Returns a new autoreleased instance of the comment with the given string value and source info.
35
36 This is a helper initializer which allows setting default values with a single message.
37
38 @param name Name of the argument.
39 @param info Source info to set.
40 @return Returns initialized object or `nil` if initialization fails.
41 @see argumentWithName:
42 */
43 + (id)argumentWithName:(NSString *)name sourceInfo:(GBSourceInfo *)info;
44
45 ///---------------------------------------------------------------------------------------
46 /// @name Argument description
47 ///---------------------------------------------------------------------------------------
48
49 /** The name of the argument.
50 */
51 @property (copy) NSString *argumentName;
52
53 /** The description components of the argument as `GBCommentComponentsList`.
54 */
63ba09d @sptramer [ISSUE-439] First pass on converting appledoc from GC->ARC.
sptramer authored
55 @property (strong) GBCommentComponentsList *argumentDescription;
42d1cf7 @tomaz Implemented method arguments registration and processing.
authored
56
57 /** Source file information.
58 */
63ba09d @sptramer [ISSUE-439] First pass on converting appledoc from GC->ARC.
sptramer authored
59 @property (strong) GBSourceInfo *sourceInfo;
42d1cf7 @tomaz Implemented method arguments registration and processing.
authored
60
61 @end
Something went wrong with that request. Please try again.