Index: src/OFArray.h ================================================================== --- src/OFArray.h +++ src/OFArray.h @@ -15,11 +15,11 @@ #import "OFDataArray.h" @class OFString; /** - * The OFArray class provides a class for storing objects in an array. + * The OFArray class is a class for storing objects in an array. */ @interface OFArray: OFObject { OFDataArray *array; } @@ -28,22 +28,28 @@ * \return A new autoreleased OFArray */ + array; /** + * Creates a new OFArray with the specified object. + * * \param obj An object * \return A new autoreleased OFArray */ + arrayWithObject: (OFObject*)obj; /** + * Creates a new OFArray with the specified objects, terminated by nil. + * * \param first The first object in the array * \return A new autoreleased OFArray */ + arrayWithObjects: (OFObject*)first, ...; /** + * Creates a new OFArray with the objects from the specified C array. + * * \param objs A C array of objects. * \return A new autoreleased OFArray */ + arrayWithCArray: (OFObject**)objs; @@ -80,21 +86,21 @@ * \return An initialized OFArray */ - initWithCArray: (OFObject**)objs; /** - * \return The number of objects in the OFArray + * \return The number of objects in the array */ - (size_t)count; /** * \return The objects of the array as a C array */ - (id*)cArray; /** - * Returns a specific object of the OFArray. + * Returns a specific object of the array. * * \param index The number of the object to return * \return The specified object of the OFArray */ - (id)objectAtIndex: (size_t)index; @@ -117,16 +123,16 @@ * the specified object */ - (size_t)indexOfObjectIdenticalTo: (OFObject*)obj; /** - * \return The first object of the OFArray or nil + * \return The first object of the array or nil */ - (id)firstObject; /** - * \return The last object of the OFArray or nil + * \return The last object of the array or nil */ - (id)lastObject; /** * Creates a string by joining all objects of the array. Index: src/OFAutoreleasePool.h ================================================================== --- src/OFAutoreleasePool.h +++ src/OFAutoreleasePool.h @@ -12,12 +12,13 @@ #import "OFObject.h" #import "OFArray.h" #import "OFList.h" /** - * The OFAutoreleasePool class provides a class that keeps track of objects - * that will be released when the autorelease pool is released. + * The OFAutoreleasePool class is a class that keeps track of objects that will + * be released when the autorelease pool is released. + * * Every thread has its own stack of autorelease pools. */ @interface OFAutoreleasePool: OFObject { OFArray *objects; Index: src/OFConstString.h ================================================================== --- src/OFConstString.h +++ src/OFConstString.h @@ -14,9 +14,9 @@ #ifdef OF_APPLE_RUNTIME extern void *_OFConstStringClassReference; #endif /** - * A class for storing static strings using the @"" literal. + * A class for storing constant strings using the @"" literal. */ @interface OFConstString: OFString {} @end Index: src/OFConstString.m ================================================================== --- src/OFConstString.m +++ src/OFConstString.m @@ -149,8 +149,8 @@ - (void)dealloc { @throw [OFNotImplementedException newWithClass: isa selector: _cmd]; - [super dealloc]; /* Get rid of stupid warning */ + [super dealloc]; /* Get rid of a stupid warning */ } @end Index: src/OFDataArray.h ================================================================== --- src/OFDataArray.h +++ src/OFDataArray.h @@ -10,12 +10,11 @@ */ #import "OFObject.h" /** - * The OFDataArray class provides a class for storing arbitrary data in an - * array. + * The OFDataArray class is a class for storing arbitrary data in an array. * * If you plan to store large hunks of data, you should consider using * OFBigDataArray, which allocates the memory in pages rather than in bytes. */ @interface OFDataArray: OFObject @@ -142,14 +141,14 @@ - removeNItems: (size_t)nitems atIndex: (size_t)index; @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 + * The OFBigDataArray class is 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/OFDictionary.h ================================================================== --- src/OFDictionary.h +++ src/OFDictionary.h @@ -20,11 +20,11 @@ OFObject *object; uint32_t hash; }; /** - * The OFDictionary class provides a class for using hash tables. + * The OFDictionary class is a class for using hash tables. */ @interface OFDictionary: OFObject { struct of_dictionary_bucket *data; size_t size; Index: src/OFExceptions.h ================================================================== --- src/OFExceptions.h +++ src/OFExceptions.h @@ -310,11 +310,11 @@ */ - (size_t)requestedSize; @end /** - * An OFException indicating a read to the file failed. + * An OFException indicating a read on the file failed. */ @interface OFReadFailedException: OFReadOrWriteFailedException {} @end /** Index: src/OFFile.h ================================================================== --- src/OFFile.h +++ src/OFFile.h @@ -129,11 +129,11 @@ @end @interface OFFileSingleton: OFFile @end -/// An OFFile object for stdin. +/// An OFFile object for stdin extern OFFile *of_stdin; -/// An OFFile object for stdout. +/// An OFFile object for stdout extern OFFile *of_stdout; -/// An OFFile object for stderr. +/// An OFFile object for stderr extern OFFile *of_stderr; Index: src/OFHashes.h ================================================================== --- src/OFHashes.h +++ src/OFHashes.h @@ -32,12 +32,10 @@ /** * \return A new autoreleased MD5 Hash */ + md5Hash; -- init; - /** * Adds a buffer to the hash to be calculated. * * \param buf The buffer which should be included into calculation. * \param size The size of the buffer @@ -68,12 +66,10 @@ /** * \return A new autoreleased SHA1 Hash */ + sha1Hash; -- init; - /** * Adds a buffer to the hash to be calculated. * * \param buf The buffer which should be included into calculation. * \param size The size of the buffer Index: src/OFMutableArray.h ================================================================== --- src/OFMutableArray.h +++ src/OFMutableArray.h @@ -10,12 +10,12 @@ */ #import "OFArray.h" /** - * The OFMutableArray class provides a class for storing, adding and removing - * objects in an array. + * The OFMutableArray class is a class for storing, adding and removing objects + * in an array. */ @interface OFMutableArray: OFArray {} /** * Adds an object to the OFArray. * Index: src/OFMutableDictionary.h ================================================================== --- src/OFMutableDictionary.h +++ src/OFMutableDictionary.h @@ -10,11 +10,11 @@ */ #import "OFDictionary.h" /** - * The OFMutableDictionary class provides a class for using mutable hash tables. + * The OFMutableDictionary class is a class for using mutable hash tables. */ @interface OFMutableDictionary: OFDictionary {} /** * Sets a key to an object. A key can be any object. *