summaryrefslogtreecommitdiff
path: root/MLKCharacter.h
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 /MLKCharacter.h
parent959c47aa115e4ee30602cac44cb0a05488bdcc01 (diff)
Documentation: Add sections.
Diffstat (limited to 'MLKCharacter.h')
-rw-r--r--MLKCharacter.h17
1 files changed, 14 insertions, 3 deletions
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: