Index: src/OFDataArray.h ================================================================== --- src/OFDataArray.h +++ src/OFDataArray.h @@ -101,10 +101,15 @@ * \param nitems The number of items to remove */ - removeNItems: (size_t)nitems; @end +/** + * The OFBigDataArray class provides a class for storing arbitrary data in an + * array and is designed to store large hunks of data. Therefore, it allocates + * memory in pages rather than a chunk of memory for each item. + */ @interface OFBigDataArray: OFDataArray { size_t size; } @end Index: src/OFHashes.h ================================================================== --- src/OFHashes.h +++ src/OFHashes.h @@ -87,11 +87,12 @@ */ - (uint8_t*)digest; @end /** - * The OFHashing category provides methods to calculate hashes for strings. + * The OFString (OFHashing) category provides methods to calculate hashes for + * strings. */ @interface OFString (OFHashing) /** * \return The MD5 hash of the string as an autoreleased OFString */ Index: src/OFIterator.h ================================================================== --- src/OFIterator.h +++ src/OFIterator.h @@ -11,13 +11,19 @@ #import "OFObject.h" #import "OFList.h" #import "OFDictionary.h" +/** + * An iterator pair combines a key and its object in a single struct. + */ typedef struct __of_iterator_pair { + /// The key id key; + /// The object for the key id object; + /// The hash of the key uint32_t hash; } of_iterator_pair_t; extern int _OFIterator_reference; Index: src/OFURLEncoding.h ================================================================== --- src/OFURLEncoding.h +++ src/OFURLEncoding.h @@ -12,12 +12,12 @@ #import "OFMutableString.h" extern int _OFURLEncoding_reference; /** - * The OFURLEncoding category provides an easy way to encode and decode strings - * for URLs. + * The OFString (OFURLEncoding) category provides an easy way to encode and + * decode strings for URLs. */ @interface OFString (OFURLEncoding) /** * Encodes a string for use in a URL. * Index: src/OFXMLElement.h ================================================================== --- src/OFXMLElement.h +++ src/OFXMLElement.h @@ -150,16 +150,16 @@ */ - addChild: (OFXMLElement*)child; @end /** - * The OFXMLEscaping category provides an easy way to escape strings for use in - * an XML document. + * The OFString (OFXMLEscaping) category provides an easy way to escape strings + * for use in an XML document. */ @interface OFString (OFXMLEscaping) /** * Escapes a string for use in an XML document. * * \return A new autoreleased string */ - stringByXMLEscaping; @end Index: src/OFXMLParser.h ================================================================== --- src/OFXMLParser.h +++ src/OFXMLParser.h @@ -73,12 +73,26 @@ - setDelegate: (OFObject *)delegate; - parseBuffer: (const char*)buf withSize: (size_t)size; @end +/** + * The OFString (OFXMLUnescaping) category provides methods to unescape XML in + * strings. + */ @interface OFString (OFXMLUnescaping) +/** + * Unescapes XML in the string. + */ - stringByXMLUnescaping; + +/** + * Unescapes XML in the string and uses the specified handler for unknown + * entities. + * + * \param h An OFXMLUnescapingDelegate as a handler for unknown entities + */ - stringByXMLUnescapingWithHandler: (OFObject *)h; @end @interface OFObject (OFXMLParserDelegate) @end