@@ -10,11 +10,11 @@ */ #import "OFObject.h" /** - * The OFEnumerator class provides methods to enumerate through collections. + * \brief A class which provides methods to enumerate through collections. */ @interface OFEnumerator: OFObject {} /** * \return The next object */ @@ -33,10 +33,13 @@ * We need this bad check to see if we already imported Cocoa, which defines * this as well. */ #define of_fast_enumeration_state_t NSFastEnumerationState #ifndef NSINTEGER_DEFINED +/** + * \brief State information for fast enumerations. + */ typedef struct __of_fast_enumeration_state { /// Arbitrary state information for the enumeration unsigned long state; /// Pointer to a C array of objects to return id *itemsPtr; @@ -46,13 +49,15 @@ unsigned long extra[5]; } of_fast_enumeration_state_t; #endif /** + * \brief A protocol for fast enumeration. + * * The OFFastEnumeration protocol needs to be implemented by all classes * supporting fast enumeration. */ @protocol OFFastEnumeration - (int)countByEnumeratingWithState: (of_fast_enumeration_state_t*)state objects: (id*)objects count: (int)count; @end