summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthias Andreas Benkard <matthias@benkard.de>2008-08-29 16:45:07 +0200
committerMatthias Andreas Benkard <matthias@benkard.de>2008-08-29 16:45:07 +0200
commitf6c59187c654e71d75d97480b96b50d5be6129e6 (patch)
treee87a56657cb49758a205d133edbd7a35fdf53ea3
parent43921ef49a4c9a4acf2182728c60a52f71dd95ec (diff)
MLKCons: Improve documentation.
-rw-r--r--MLKCons.h23
1 files changed, 21 insertions, 2 deletions
diff --git a/MLKCons.h b/MLKCons.h
index 4b46272..8a79a99 100644
--- a/MLKCons.h
+++ b/MLKCons.h
@@ -47,7 +47,7 @@
car - The car of the new cons cell.
cdr - The cdr of the new cons cell.
- Returns: A newly allocated cons.
+ Returns: A newly allocated cons.
*/
+(MLKCons*) cons:(id)car with:(id)cdr;
@@ -59,31 +59,50 @@
/* Method: -initWithCar:cdr:
- Initialise a new cons cell with car and cdr.
+ Initialise a new cons cell with a car and cdr.
+
+ Arguments:
+
+ car - The car of the cons cell.
+ cdr - The cdr of the cons cell.
+
+ Returns: The initialised cons cell.
*/
-(MLKCons*) initWithCar:(id)car cdr:(id)cdr;
/* Method: -car
The car of the cons cell.
+
+ Returns: An object (may be nil).
*/
-(id) car;
/* Method: -cdr
The cdr of the cons cell.
+
+ Returns: An object (may be nil).
*/
-(id) cdr;
/* Method: -setCar:
Change the car of the cons cell.
+
+ Arguments:
+
+ value - The new value.
*/
-(void) setCar:(id)value;
/* Method: -setCdr:
Change the cdr of the cons cell.
+
+ Arguments:
+
+ value - The new value.
*/
-(void) setCdr:(id)value;