@@ -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.