Permalink
Browse files

More documentation comments.

  • Loading branch information...
1 parent 4a2963b commit 898263b3a6ed0734acbf341c538ae2bddcdbf986 Alex Olson committed Jan 3, 2011
Showing with 20 additions and 12 deletions.
  1. +10 −6 Examples/CocoaApp/Kynetx.h
  2. +10 −6 kynetx.h
View
@@ -14,6 +14,7 @@
This is a library for interacting with <a href = "http://www.kynetx.com" target="_blank">Kynetx</a>.
@author Alex Olson
+ */
/**
@brief An object that handles raising events to kynetx and parsing returned directives
@@ -39,7 +40,7 @@
/**
@brief Basic init method.
- @returns self
+ @return self
*/
-(id) init;
@@ -48,7 +49,7 @@
This is the preferred initialization method.
@param input the appid to initialize the object with.
- @returns self
+ @return self
*/
-(id) initWithAppID:(id) input;
@@ -61,26 +62,29 @@
for more information regarding events.
@param name name of the event to raise
@param params a dictionary of key-value pairs to send to kynetx ruleset
- @returns result of parseDirectives
+ @return result of parseDirectives
*/
-(NSArray*) raiseEvent:(NSString*) name params:(NSDictionary*) params;
/**
@brief parse directives returned by KNS for a raised event
@param response NSData* object returned by a GET request
- @returns NSArray* of NSDictionary* directives
+ @return NSArray* of NSDictionary* directives
*/
-(NSArray*) parseDirectives:(NSData*) response;
/**
@brief build a NSURL* from a NSDictionary and a NSString
@param params url paramaters to add to url string
@param URLString URL string to add params to
- @returns NSURL*
+ @return NSURL*
*/
-(NSURL*) URLFromDict:(NSDictionary*) params withBaseURL:(NSString*) URLString;
-/// destructor
+/**
+ @brief releases object alloced memory
+ @return void
+ */
-(void) dealloc;
View
@@ -14,6 +14,7 @@
This is a library for interacting with <a href = "http://www.kynetx.com" target="_blank">Kynetx</a>.
@author Alex Olson
+ */
/**
@brief An object that handles raising events to kynetx and parsing returned directives
@@ -39,7 +40,7 @@
/**
@brief Basic init method.
- @returns self
+ @return self
*/
-(id) init;
@@ -48,7 +49,7 @@
This is the preferred initialization method.
@param input the appid to initialize the object with.
- @returns self
+ @return self
*/
-(id) initWithAppID:(id) input;
@@ -61,26 +62,29 @@
for more information regarding events.
@param name name of the event to raise
@param params a dictionary of key-value pairs to send to kynetx ruleset
- @returns result of parseDirectives
+ @return result of parseDirectives
*/
-(NSArray*) raiseEvent:(NSString*) name params:(NSDictionary*) params;
/**
@brief parse directives returned by KNS for a raised event
@param response NSData* object returned by a GET request
- @returns NSArray* of NSDictionary* directives
+ @return NSArray* of NSDictionary* directives
*/
-(NSArray*) parseDirectives:(NSData*) response;
/**
@brief build a NSURL* from a NSDictionary and a NSString
@param params url paramaters to add to url string
@param URLString URL string to add params to
- @returns NSURL*
+ @return NSURL*
*/
-(NSURL*) URLFromDict:(NSDictionary*) params withBaseURL:(NSString*) URLString;
-/// destructor
+/**
+ @brief releases object alloced memory
+ @return void
+ */
-(void) dealloc;

0 comments on commit 898263b

Please sign in to comment.