Index: Doxyfile ================================================================== --- Doxyfile +++ Doxyfile @@ -2,5 +2,6 @@ OUTPUT_DIRECTORY = docs/ INPUT = src FILE_PATTERNS = *.h *.m HTML_OUTPUT = . GENERATE_LATEX = NO +HIDE_UNDOC_CLASSES = YES Index: src/OFArray.h ================================================================== --- src/OFArray.h +++ src/OFArray.h @@ -67,11 +67,11 @@ * \param objs A C array of objects * \param len The length of the C array * \return A new autoreleased OFArray */ + arrayWithCArray: (id*)objs - length: (size_t)length; + length: (size_t)len; /** * Initializes an OFArray with the specified object. * * \param obj An object @@ -206,11 +206,10 @@ */ - (void)enumerateObjectsUsingBlock: (of_array_enumeration_block_t)block; #endif @end -/// \cond internal @interface OFArrayEnumerator: OFEnumerator { OFDataArray *array; size_t count; unsigned long mutations; @@ -219,8 +218,7 @@ } - initWithDataArray: (OFDataArray*)data mutationsPointer: (unsigned long*)mutations_ptr; @end -/// \endcond #import "OFMutableArray.h" Index: src/OFArray.m ================================================================== --- src/OFArray.m +++ src/OFArray.m @@ -416,11 +416,10 @@ [super dealloc]; } @end -/// \cond internal @implementation OFArrayEnumerator - initWithDataArray: (OFDataArray*)array_ mutationsPointer: (unsigned long*)mutationsPtr_; { self = [super init]; @@ -450,6 +449,5 @@ @throw [OFEnumerationMutationException newWithClass: isa]; pos = 0; } @end -/// \endcond Index: src/OFBlock.h ================================================================== --- src/OFBlock.h +++ src/OFBlock.h @@ -9,33 +9,33 @@ * the packaging of this file. */ #import "OFObject.h" -/// \cond internal -typedef struct __of_block_literal { +typedef struct of_block_literal_t { Class isa; int flags; int reserved; void (*invoke)(void *, ...); - struct __of_block_descriptor { + struct of_block_descriptor_t { unsigned long reserved; unsigned long size; void (*copy_helper)(void *dest, void *src); void (*dispose_helper)(void *src); const char *signature; } *descriptor; } of_block_literal_t; -typedef struct __of_block_byref { +typedef struct of_block_byref_t of_block_byref_t; +struct of_block_byref_t { Class isa; - struct __of_block_byref *forwarding; + of_block_byref_t *forwarding; int flags; int size; void (*byref_keep)(void *dest, void *src); void (*byref_dispose)(void*); -} of_block_byref_t; +}; enum { OF_BLOCK_HAS_COPY_DISPOSE = (1 << 25), OF_BLOCK_HAS_CTOR = (1 << 26), OF_BLOCK_IS_GLOBAL = (1 << 28), @@ -51,11 +51,10 @@ OF_BLOCK_FIELD_IS_BLOCK = 7, OF_BLOCK_FIELD_IS_BYREF = 8, OF_BLOCK_FIELD_IS_WEAK = 16, OF_BLOCK_BYREF_CALLER = 128, }; -/// \endcond extern void* _Block_copy(const void*); extern void _Block_release(const void*); #ifndef Block_copy @@ -63,11 +62,10 @@ #endif #ifndef Block_release # define Block_release(x) _Block_release((const void*)(x)) #endif -/// \cond internal @interface OFBlock: OFObject @end @interface OFStackBlock: OFBlock @end @@ -75,6 +73,5 @@ @interface OFGlobalBlock: OFBlock @end @interface OFMallocBlock: OFBlock @end -/// \endcond Index: src/OFBlock.m ================================================================== --- src/OFBlock.m +++ src/OFBlock.m @@ -21,16 +21,14 @@ #import "OFBlock.h" #import "OFExceptions.h" #import "atomic.h" -/// \cond internal @protocol RetainRelease - retain; - (void)release; @end -/// \endcond #if defined(OF_GNU_RUNTIME) || defined(OF_OBJFW_RUNTIME) struct objc_abi_class { struct objc_abi_metaclass *metaclass; const char *superclass, *name; @@ -246,11 +244,10 @@ } break; } } -/// \cond internal @implementation OFBlock #if defined(OF_APPLE_RUNTIME) && !defined(__OBJC2__) + (void)load { Class tmp; @@ -408,6 +405,5 @@ */ [self class]; } @end #endif -/// \endcond Index: src/OFDictionary.h ================================================================== --- src/OFDictionary.h +++ src/OFDictionary.h @@ -19,18 +19,16 @@ #ifdef OF_HAVE_BLOCKS typedef void (^of_dictionary_enumeration_block_t)(id key, id obj, BOOL *stop); #endif -/// \cond internal struct of_dictionary_bucket { id key; id object; uint32_t hash; }; -/// \endcond /** * \brief A class for storing objects in a hash table. */ @interface OFDictionary: OFObject key; else return nil; } @end -/// \endcond Index: src/OFEnumerator.h ================================================================== --- src/OFEnumerator.h +++ src/OFEnumerator.h @@ -36,11 +36,11 @@ #define of_fast_enumeration_state_t NSFastEnumerationState #ifndef NSINTEGER_DEFINED /** * \brief State information for fast enumerations. */ -typedef struct __of_fast_enumeration_state { +typedef struct of_fast_enumeration_state_t { /// Arbitrary state information for the enumeration unsigned long state; /// Pointer to a C array of objects to return id *itemsPtr; /// Arbitrary state information to detect mutations Index: src/OFExceptions.h ================================================================== --- src/OFExceptions.h +++ src/OFExceptions.h @@ -1161,11 +1161,11 @@ @property (readonly, nonatomic) OFString *prefix; #endif /** * \param class_ The class of the object which caused the exception - * \param namespace The namespace which is unbound + * \param ns The namespace which is unbound * \return A new unbound namespace exception */ + newWithClass: (Class)class_ namespace: (OFString*)ns; @@ -1179,11 +1179,11 @@ /** * Initializes an already allocated unbound namespace failed exception * * \param class_ The class of the object which caused the exception - * \param namespace The namespace which is unbound + * \param ns The namespace which is unbound * \return An initialized unbound namespace exception */ - initWithClass: (Class)class_ namespace: (OFString*)ns; Index: src/OFFile.h ================================================================== --- src/OFFile.h +++ src/OFFile.h @@ -173,11 +173,8 @@ * It is not closed when the OFFile object is deallocated! */ - initWithFileDescriptor: (int)fd; @end -/// An OFFile object for stdin extern OFFile *of_stdin; -/// An OFFile object for stdout extern OFFile *of_stdout; -/// An OFFile object for stderr extern OFFile *of_stderr; Index: src/OFFile.m ================================================================== --- src/OFFile.m +++ src/OFFile.m @@ -83,14 +83,12 @@ return O_RDWR | O_CREAT | O_APPEND | O_BINARY; return -1; } -/// \cond internal @interface OFFileSingleton: OFFile @end -/// \endcond @implementation OFFile + (void)load { if (self != [OFFile class]) @@ -536,11 +534,10 @@ [super dealloc]; } @end -/// \cond internal @implementation OFFileSingleton - initWithPath: (OFString*)path mode: (OFString*)mode { Class c = isa; @@ -573,6 +570,5 @@ @throw [OFNotImplementedException newWithClass: isa selector: _cmd]; [super dealloc]; /* Get rid of stupid warning */ } @end -/// \endcond Index: src/OFList.h ================================================================== --- src/OFList.h +++ src/OFList.h @@ -11,24 +11,25 @@ #import "OFObject.h" #import "OFCollection.h" #import "OFEnumerator.h" +typedef struct of_list_object_t of_list_object_t; /** * \brief A list object. * * A struct that contains a pointer to the next list object, the previous list * object and the object. */ -typedef struct __of_list_object { +struct of_list_object_t { /// A pointer to the next list object in the list - struct __of_list_object *next; + of_list_object_t *next; /// A pointer to the previous list object in the list - struct __of_list_object *prev; + of_list_object_t *prev; /// The object for the list object - id object; -} of_list_object_t; + id object; +}; /** * \brief A class which provides easy to use double-linked lists. */ @interface OFList: OFObject @@ -109,11 +110,10 @@ * \param listobj The list object returned by append / prepend */ - (void)removeListObject: (of_list_object_t*)listobj; @end -/// \cond internal @interface OFListEnumerator: OFEnumerator { of_list_object_t *first; of_list_object_t *current; unsigned long mutations; @@ -121,6 +121,5 @@ } - initWithFirstListObject: (of_list_object_t*)first mutationsPointer: (unsigned long*)mutations_ptr; @end -/// \endcond Index: src/OFList.m ================================================================== --- src/OFList.m +++ src/OFList.m @@ -311,11 +311,10 @@ initWithFirstListObject: firstListObject mutationsPointer: &mutations] autorelease]; } @end -/// \cond internal @implementation OFListEnumerator - initWithFirstListObject: (of_list_object_t*)first_ mutationsPointer: (unsigned long*)mutationsPtr_; { self = [super init]; @@ -350,6 +349,5 @@ @throw [OFEnumerationMutationException newWithClass: isa]; current = first; } @end -/// \endcond Index: src/OFMutableArray.h ================================================================== --- src/OFMutableArray.h +++ src/OFMutableArray.h @@ -42,11 +42,11 @@ /** * Replaces the first object equivalent to the first specified object with the * second specified object. * * \param old The object to replace - * \param new The replacement object + * \param new_ The replacement object */ - (void)replaceObject: (id)old withObject: (id)new_; /** @@ -61,11 +61,11 @@ /** * Replaces the first object that has the same address as the first specified * object with the second specified object. * * \param old The object to replace - * \param new The replacement object + * \param new_ The replacement object */ - (void)replaceObjectIdenticalTo: (id)old withObject: (id)new_; /** Index: src/OFObject.h ================================================================== --- src/OFObject.h +++ src/OFObject.h @@ -21,11 +21,11 @@ #endif /** * \brief A result of a comparison. */ -typedef enum __of_comparison_result { +typedef enum of_comparison_result_t { /// The left object is smaller than the right OF_ORDERED_ASCENDING = -1, /// Both objects are equal OF_ORDERED_SAME = 0, /// The left object is bigger than the right @@ -33,12 +33,14 @@ } of_comparison_result_t; /** * \brief A range. */ -typedef struct __of_range { +typedef struct of_range_t { + /// The start of the range size_t start; + /// The length of the range size_t length; } of_range_t; @class OFString; Index: src/OFObject.m ================================================================== --- src/OFObject.m +++ src/OFObject.m @@ -50,20 +50,18 @@ # define class_getInstanceSize class_get_instance_size # define class_getName class_get_class_name # define class_getSuperclass class_get_super_class #endif -/// \cond internal struct pre_ivar { void **memchunks; size_t memchunks_size; int32_t retain_count; #ifndef OF_ATOMIC_OPS of_spinlock_t retain_spinlock; #endif }; -/// \endcond /* Hopefully no arch needs more than 16 bytes padding */ #define PRE_IVAR_ALIGN ((sizeof(struct pre_ivar) + 15) & ~15) #define PRE_IVAR ((struct pre_ivar*)((char*)self - PRE_IVAR_ALIGN)) Index: src/OFSHA1Hash.m ================================================================== --- src/OFSHA1Hash.m +++ src/OFSHA1Hash.m @@ -45,16 +45,14 @@ w = OF_ROL(w, 30); #define R4(v, w, x, y, z, i) \ z += (w ^ x ^ y) + blk(i) + 0xCA62C1D6 + OF_ROL(v, 5); \ w = OF_ROL(w, 30); -/// \cond internal typedef union { char c[64]; uint32_t l[16]; } sha1_c64l16_t; -/// \endcond static inline void sha1_transform(uint32_t state[5], const char buffer[64]) { uint32_t a, b, c, d, e; Index: src/OFString+XMLUnescaping.h ================================================================== --- src/OFString+XMLUnescaping.h +++ src/OFString+XMLUnescaping.h @@ -27,10 +27,11 @@ * This callback is called when an unknown entity was found while trying to * unescape XML. The callback is supposed to return a substitution for the * entity or nil if it is unknown to the callback as well, in which case an * exception will be thrown. * + * \param str The string which contains the unknown entity * \param entity The name of the entity that is unknown * \return A substitution for the entity or nil */ - (OFString*)string: (OFString*)str containsUnknownEntityNamed: (OFString*)entity; @@ -47,21 +48,21 @@ /** * Unescapes XML in the string and uses the specified delegate for unknown * entities. * - * \param h An OFXMLUnescapingDelegate as a handler for unknown entities + * \param delegate An OFXMLUnescapingDelegate as a handler for unknown entities */ - (OFString*)stringByXMLUnescapingWithDelegate: (id )delegate; #ifdef OF_HAVE_BLOCKS /** * Unescapes XML in the string and uses the specified block for unknown * entities. * - * \param h A block as a handler for unknown entities + * \param block A block which handles unknown entities */ - (OFString*)stringByXMLUnescapingWithBlock: (of_string_xml_unescaping_block_t)block; #endif @end Index: src/OFThread.h ================================================================== --- src/OFThread.h +++ src/OFThread.h @@ -123,11 +123,11 @@ + (void)terminate; /** * Terminates the current thread, letting it return the specified object. * - * \param The object which the terminated thread will return + * \param obj The object which the terminated thread will return */ + (void)terminateWithObject: (id)obj; /** * \param obj An object that is passed to the main method as a copy or nil Index: src/OFXMLParser.h ================================================================== --- src/OFXMLParser.h +++ src/OFXMLParser.h @@ -86,11 +86,11 @@ /** * This callback is called when the XML parser found CDATA. * * \param parser The parser which found a string - * \param string The string the XML parser found + * \param cdata The CDATA the XML parser found */ - (void)parser: (OFXMLParser*)parser foundCDATA: (OFString*)cdata; /** Index: src/objc_sync.m ================================================================== --- src/objc_sync.m +++ src/objc_sync.m @@ -21,19 +21,17 @@ # import #endif #import "threading.h" -/// \cond internal struct locks_s { id obj; size_t count; size_t recursion; of_thread_t thread; of_mutex_t mutex; }; -/// \endcond static of_mutex_t mutex; static struct locks_s *locks = NULL; static size_t num_locks = 0;