@@ -118,11 +118,13 @@ /** * \brief An enum for storing endianess. */ typedef enum of_byte_order_t { + /// Most significant byte first (big endian) OF_BYTE_ORDER_BIG_ENDIAN, + /// Least significant byte first (little endian) OF_BYTE_ORDER_LITTLE_ENDIAN } of_byte_order_t; /** * \brief A range. @@ -136,28 +138,34 @@ /** * \brief A point. */ typedef struct of_point_t { + /// The x coordinate of the point float x; + /// The y coordinate of the point float y; } of_point_t; /** * \brief A dimension. */ typedef struct of_dimension_t { + /// The width of the dimension float width; + /// The height of the dimension float height; } of_dimension_t; /** * \brief A rectangle. */ typedef struct of_rectangle_t { + /// The point from where the rectangle originates of_point_t origin; + /// The size of the rectangle of_dimension_t size; } of_rectangle_t; @class OFString; @class OFThread; @@ -327,11 +335,10 @@ * \brief The root class for all other classes inside ObjFW. */ @interface OFObject { @public - /// The class of the object Class isa; } /** * \brief A method which is called once when the class is loaded into the @@ -363,11 +370,11 @@ * \return The allocated object */ + alloc; /** - * \brief Allocates memory for a new instance and calls -[init] on it. + * \brief Allocates memory for a new instance and calls \ref init on it. * \return An allocated and initialized object */ + new; /** @@ -512,11 +519,11 @@ * done. * * The methods which will be added from the specified class are not allowed to * use super or access instance variables, instead they have to use accessors. * - * \param class The class from which the instance methods should be inherited + * \param class_ The class from which the instance methods should be inherited */ + (void)inheritMethodsFromClass: (Class)class_; /** * \brief Try to resolve the specified class method. @@ -539,13 +546,17 @@ + (BOOL)resolveInstanceMethod: (SEL)selector; /** * \brief Initializes an already allocated object. * - * Derived classes may override this, but need to do self = [super init] before - * they do any initialization themselves. init may never return nil, instead - * an exception (for example OFInitializationFailed) should be thrown. + * Derived classes may override this, but need to do + * \code + * self = [super init] + * \endcode + * before they do any initialization themselves. \ref init may never return nil, + * instead an exception (for example OFInitializationFailedException) should be + * thrown. * * \return An initialized object */ - init;