@@ -15,11 +15,11 @@ #include #import /** - * A result of a comparison. + * \brief A result of a comparison. */ typedef enum __of_comparison_result { /// The left object is smaller than the right OF_ORDERED_ASCENDING = -1, /// Both objects are equal @@ -27,19 +27,19 @@ /// The left object is bigger than the right OF_ORDERED_DESCENDING = 1 } of_comparison_result_t; /** - * A range. + * \brief A range. */ typedef struct __of_range { size_t start; size_t length; } of_range_t; /** - * The OFObject class is the base class for all other classes inside ObjFW. + * \brief The root class for all other classes inside ObjFW. */ @interface OFObject { /// The class of the object Class isa; @@ -302,24 +302,26 @@ */ - (void)dealloc; @end /** - * Objects implementing this protocol can be copied. + * \brief A protocol for creation of copies. */ @protocol OFCopying /** * \return A copy of the object */ - (id)copy; @end /** + * \brief A protocol for creation of mutable copies. + * * This protocol is implemented by objects that can be mutable and immutable * and allows returning a mutable copy. */ @protocol OFMutableCopying /** * \return A copy of the object */ - (id)mutableCopy; @end