Index: src/OFArray.h ================================================================== --- src/OFArray.h +++ src/OFArray.h @@ -54,11 +54,11 @@ - initWithObject: (OFObject*)obj; /** * Initializes an OFArray with the specified objects. * - * \param obj The first object + * \param first The first object * \return An initialized OFArray */ - initWithObjects: (OFObject*)first, ...; /** Index: src/OFDataArray.h ================================================================== --- src/OFDataArray.h +++ src/OFDataArray.h @@ -61,11 +61,11 @@ * Compares the OFDataArray to another object. * * \param ary A data array to compare with * \return An of_comparsion_result_t */ -- (of_comparison_result_t)compare: (OFDataArray*)obj; +- (of_comparison_result_t)compare: (OFDataArray*)ary; /** * Returns a specific item of the OFDataArray. * * \param index The number of the item to return Index: src/OFDictionary.h ================================================================== --- src/OFDictionary.h +++ src/OFDictionary.h @@ -124,10 +124,11 @@ /** * Initializes an already allocated OFDictionary with the specified key and * va_list. * * \param first The first key + * \param args A va_list of the other arguments * \return A new initialized OFDictionary */ - initWithKey: (OFObject *)first argList: (va_list)args; Index: src/OFExceptions.h ================================================================== --- src/OFExceptions.h +++ src/OFExceptions.h @@ -40,11 +40,11 @@ /** * The OFException class is the base class for all exceptions in ObjFW. * * IMPORTANT: Exceptions do NOT use OFAutoreleasePools and can't be autoreleased - * either! You have to make sure to dealloc the exception in your @catch block! + * either! You have to make sure to dealloc the exception in your \@catch block! */ @interface OFException: OFObject { Class class_; OFString *string; @@ -559,12 +559,12 @@ int err; } /** * \param class_ The class of the object which caused the exception - * \param source The source for the link - * \param destination The destination for the link + * \param src The source for the link + * \param dest The destination for the link * \return A new link failed exception */ + newWithClass: (Class)class_ source: (OFString*)src destination: (OFString*)dest; @@ -571,12 +571,12 @@ /** * Initializes an already allocated link failed exception. * * \param class_ The class of the object which caused the exception - * \param source The source for the link - * \param destination The destination for the link + * \param src The source for the link + * \param dest The destination for the link * \return An initialized link failed exception */ - initWithClass: (Class)class_ source: (OFString*)src destination: (OFString*)dest; @@ -607,12 +607,12 @@ int err; } /** * \param class_ The class of the object which caused the exception - * \param source The source for the symlink - * \param destination The destination for the symlink + * \param src The source for the symlink + * \param dest The destination for the symlink * \return A new symlink failed exception */ + newWithClass: (Class)class_ source: (OFString*)src destination: (OFString*)dest; @@ -619,12 +619,12 @@ /** * Initializes an already allocated symlink failed exception. * * \param class_ The class of the object which caused the exception - * \param source The source for the symlink - * \param destination The destination for the symlink + * \param src The source for the symlink + * \param dest The destination for the symlink * \return An initialized symlink failed exception */ - initWithClass: (Class)class_ source: (OFString*)src destination: (OFString*)dest; Index: src/OFFile.h ================================================================== --- src/OFFile.h +++ src/OFFile.h @@ -142,13 +142,13 @@ intoBuffer: (char*)buf; /** * Writes from a buffer into the file. * - * \param buf The buffer from which the data is written to the file + * \param nitems The number of items to write * \param size The size of the data that should be written - * \param nitem The number of items to write + * \param buf The buffer from which the data is written to the file * \return The number of bytes written */ - (size_t)writeNItems: (size_t)nitems ofSize: (size_t)size fromBuffer: (const char*)buf; Index: src/OFIterator.h ================================================================== --- src/OFIterator.h +++ src/OFIterator.h @@ -47,10 +47,13 @@ * Resets the iterator, so the next call to nextObject returns the first again. */ - reset; @end +/** + * The OFIterator category adds functions to get an interator to OFDictionary. + */ @interface OFDictionary (OFIterator) /** * Creates an OFIterator for the dictionary. * * It will copy the data of the OFDictionary so that OFIterator will always Index: src/OFMutableArray.h ================================================================== --- src/OFMutableArray.h +++ src/OFMutableArray.h @@ -64,8 +64,8 @@ * Removes the specified amount of objects at the specified index. * * \param nobjects The number of objects to remove * \param index The index at which the objects are removed */ -- removeNObjects: (size_t)nitems +- removeNObjects: (size_t)nobjects atIndex: (size_t)index; @end Index: src/OFNumber.h ================================================================== --- src/OFNumber.h +++ src/OFNumber.h @@ -194,11 +194,11 @@ * \return A new autoreleased OFNumber */ + numberWithUIntMax: (uintmax_t)uintmax; /** - * \param ptrdifff A ptrdiff_t which the OFNumber should contain + * \param ptrdiff A ptrdiff_t which the OFNumber should contain * \return A new autoreleased OFNumber */ + numberWithPtrDiff: (ptrdiff_t)ptrdiff; /** Index: src/OFObject.h ================================================================== --- src/OFObject.h +++ src/OFObject.h @@ -103,12 +103,12 @@ + (IMP)instanceMethodForSelector: (SEL)selector; /** * Replaces a method implementation with another implementation. * + * \param newimp The new implementation for the method * \param selector The selector of the method to replace - * \param imp The new implementation for the method * \return The old implementation */ + (IMP)setImplementation: (IMP)newimp forMethod: (SEL)selector; Index: src/OFTCPSocket.h ================================================================== --- src/OFTCPSocket.h +++ src/OFTCPSocket.h @@ -28,11 +28,11 @@ /** * Bind socket on the specified node and service. * * \param service The service to bind * \param node The node to bind to - * \param protocol The protocol to use (AF_INET or AF_INET6) + * \param family The family to use (AF_INET or AF_INET6) */ - bindService: (OFString*)service onNode: (OFString*)node withFamily: (int)family; Index: src/OFXMLParser.h ================================================================== --- src/OFXMLParser.h +++ src/OFXMLParser.h @@ -21,10 +21,11 @@ */ @protocol OFXMLParserDelegate /** * This callback is called when the XML parser found the start of a new tag. * + * \param parser The parser which found a new tag * \param name The name of the tag which just started * \param prefix The prefix of the tag which just started or nil * \param ns The namespace of the tag which just started or nil * \param attrs The attributes included in the tag which just started or nil */ @@ -35,10 +36,11 @@ attributes: (OFArray*)attrs; /** * This callback is called when the XML parser found the end of a tag. * + * \param parser The parser which found the end of a tag * \param name The name of the tag which just ended * \param prefix The prefix of the tag which just ended or nil * \param ns The namespace of the tag which just ended or nil */ - (void)xmlParser: (OFXMLParser*)parser @@ -47,18 +49,20 @@ namespace: (OFString*)ns; /** * This callback is called when the XML parser found a string. * + * \param parser The parser which found a string * \param string The string the XML parser found */ - (void)xmlParser: (OFXMLParser*)parser foundString: (OFString*)string; /** * This callback is called when the XML parser found a comment. * + * \param parser The parser which found a comment * \param comment The comment the XML parser found */ - (void)xmlParser: (OFXMLParser*)parser foundComment: (OFString*)comment; @@ -66,10 +70,11 @@ * This callback is called when the XML parser found an entity it doesn't know. * The callback is supposed to return a substitution for the entity or nil if * it is not known to the callback as well, in which case an exception will be * risen. * + * \param parser The parser which found an unknown entity * \param entity The name of the entity the XML parser didn't know * \return A substitution for the entity or nil */ - (OFString*)xmlParser: (OFXMLParser*)parser foundUnknownEntityNamed: (OFString*)entity; @@ -87,11 +92,11 @@ * exception will be risen. * * \param entity The name of the entity that is unknown * \return A substitution for the entity or nil */ -- (OFString*)foundUnknownEntityNamed: (OFString*)entitiy; +- (OFString*)foundUnknownEntityNamed: (OFString*)entity; @end /** * An event-based XML parser which calls the delegate's callbacks as soon as * it finds something, thus suitable for streams as well.