Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Added documentation

  • Loading branch information...
commit ae4dedaf29ec9e881f96b050d8e4bf5a4a326b0f 1 parent 4d232ec
robvdveer authored
View
6 Model/GBEnumConstantData.h
@@ -8,6 +8,7 @@
#import "GBModelBase.h"
+/** Describes a single enumeration constant */
@interface GBEnumConstantData : GBModelBase
{
@private
@@ -16,7 +17,12 @@
}
+(id)constantWithName:(NSString *)name;
+/** the name of the constant */
@property (readonly) NSString *name;
+
+/** An option assigned value for this constant */
@property (copy) NSString *assignedValue;
+
+/** A boolean indicating if this enum has an assigned value. The boolean is used in the generation phase */
@property (readonly) bool hasAssignedValue;
@end
View
2  Model/GBEnumConstantProvider.h
@@ -9,6 +9,7 @@
#import <Foundation/Foundation.h>
#import "GBEnumConstantData.h"
+/** Provides abstract access to enumerated constants withing a typedef'd enum */
@interface GBEnumConstantProvider : NSObject
{
@private
@@ -20,5 +21,6 @@
- (id)initWithParentObject:(id)parent;
- (void)registerConstant:(GBEnumConstantData *)constant;
+/** the collection of constants defined for this enum */
@property (readonly) NSArray *constants;
@end
View
6 Model/GBTypedefEnumData.h
@@ -10,6 +10,10 @@
#import "GBObjectDataProviding.h"
#import "GBEnumConstantProvider.h"
+/** Defines a single typedef enumeration, consisting of several constant definitions
+ *
+ * The parser will populate the structures for use. Currently, only NS_ENUM type definitions are supported.
+ */
@interface GBTypedefEnumData : GBModelBase
{
@private
@@ -24,7 +28,7 @@
@property (readonly) NSString *nameOfEnum;
@property (readonly) GBEnumConstantProvider *constants;
-/** The type of enum, e.g. NS_ENUM (NSInteger, name), this will be NSInteger */
+/** The type of enum, e.g. for typdef NS_ENUM (NSInteger, name) {..} the value us `NSInteger` */
@property (copy) NSString *enumPrimitive;
/** True when the enum is defined as NS_OPTIONS */
View
2  appledoc.xcodeproj/project.pbxproj
@@ -556,6 +556,7 @@
B4D1FFD415FF5F05009736E2 /* DDXcodeProjectFile.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = DDXcodeProjectFile.m; sourceTree = "<group>"; };
B4D1FFF215FF633F009736E2 /* libz.dylib */ = {isa = PBXFileReference; lastKnownFileType = "compiled.mach-o.dylib"; name = libz.dylib; path = usr/lib/libz.dylib; sourceTree = SDKROOT; };
B4D1FFF615FF643D009736E2 /* install-appledoc.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = "install-appledoc.sh"; sourceTree = "<group>"; };
+ D45D15E117D883C700B7976A /* CommentsFormattingStyle.markdown */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = CommentsFormattingStyle.markdown; sourceTree = "<group>"; };
D4B844EA17A121000012C1DC /* GBTypedefEnumData.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = GBTypedefEnumData.h; sourceTree = "<group>"; };
D4B844EB17A121030012C1DC /* GBTypedefEnumData.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = GBTypedefEnumData.m; sourceTree = "<group>"; };
D4B844ED17A122640012C1DC /* GBEnumConstantData.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = GBEnumConstantData.h; sourceTree = "<group>"; };
@@ -604,6 +605,7 @@
08FB7794FE84155DC02AAC07 /* appledoc */ = {
isa = PBXGroup;
children = (
+ D45D15E117D883C700B7976A /* CommentsFormattingStyle.markdown */,
B4D1FFF615FF643D009736E2 /* install-appledoc.sh */,
73EA656912B7944E00398BD1 /* Readme.markdown */,
73EEB7A812CA2BE700E546DB /* Developer Notes.markdown */,
Please sign in to comment.
Something went wrong with that request. Please try again.