summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthias Benkard <mulk@minimulk.mst-plus>2008-08-31 10:57:21 +0200
committerMatthias Benkard <mulk@minimulk.mst-plus>2008-08-31 10:57:21 +0200
commit15e2f2443fa6ee9b3b4a78752ecafcc0722c7511 (patch)
tree30eadd91073605a144ee74d7a2494de732afb7f3
parent959c47aa115e4ee30602cac44cb0a05488bdcc01 (diff)
Documentation: Add sections.
-rw-r--r--MLKBinding.h8
-rw-r--r--MLKCharacter.h17
-rw-r--r--MLKCons.h9
3 files changed, 30 insertions, 4 deletions
diff --git a/MLKBinding.h b/MLKBinding.h
index 725037f..421b731 100644
--- a/MLKBinding.h
+++ b/MLKBinding.h
@@ -19,6 +19,9 @@
#import <Foundation/NSObject.h>
+/* Class: MLKBinding
+
+A binding in some environment. */
@interface MLKBinding : NSObject
{
id value;
@@ -26,6 +29,8 @@
+(void) initialize;
+/*** Section: Initialisation and Allocation ***/
+
/* Function: -init
Initalise unbound binding cell.
@@ -38,6 +43,9 @@
*/
-(MLKBinding *) initWithValue:(id)something;
+
+/*** Section: Accessing Content ***/
+
/* Function: +binding
Construct an unbound binding cell.
diff --git a/MLKCharacter.h b/MLKCharacter.h
index c87327d..4d2c666 100644
--- a/MLKCharacter.h
+++ b/MLKCharacter.h
@@ -19,11 +19,16 @@
#import <Foundation/NSString.h>
+/* Class: MLKCharacter
+
+A character. */
@interface MLKCharacter : NSObject
{
unichar unichar;
}
+/*** Section: Creating and Initialising Characters ***/
+
/* Function: -initWithUnichar:
Initialise character with a given numeric value.
@@ -36,12 +41,18 @@
*/
+(MLKCharacter *) characterWithUnichar:(unichar)anUnichar;
+
+/*** Section: Getting the Numeric Value ***/
+
/* Function: -unicharValue
Access the character's numeric value.
*/
-(unichar) unicharValue;
+
+/*** Section: Changing the Case ***/
+
/* Function: -uppercaseCharacter
Return the uppercase form of the character.
@@ -58,7 +69,7 @@
*/
-(MLKCharacter *) lowercaseCharacter;
-/* Function: -uppercaseCharacter
+/* Function: -uppercaseChar
Return the uppercase form of the character as a numeric value.
@@ -66,13 +77,13 @@
*/
-(unichar) uppercaseChar;
-/* Function: -uppercaseChar
+/* Function: -lowercaseChar
Return the lowercase form of the character as a numeric value.
If the character does not have case, -lowercaseChar returns [self unicharValue].
*/
--(unichar) uppercaseCharForChar;
+-(unichar) lowercaseChar;
/* Function: +uppercaseCharForChar:
diff --git a/MLKCons.h b/MLKCons.h
index 8a79a99..32c346c 100644
--- a/MLKCons.h
+++ b/MLKCons.h
@@ -38,6 +38,8 @@
id _cdr;
}
+/*** Section: Creating and Initialising Conses ***/
+
/* Method: +cons:with:
Cons two objects together.
@@ -51,7 +53,6 @@
*/
+(MLKCons*) cons:(id)car with:(id)cdr;
-
/* Method: +listWithArray:
Make a linked list of cons cells out of an array. */
@@ -70,6 +71,9 @@
*/
-(MLKCons*) initWithCar:(id)car cdr:(id)cdr;
+
+/*** Section: Accessing Components ***/
+
/* Method: -car
The car of the cons cell.
@@ -106,6 +110,9 @@
*/
-(void) setCdr:(id)value;
+
+/*** Section: Converting to Other Container Types ***/
+
/* Method: -array
Return the content of the linked list represented by this cons cell as an array.