@@ -1,7 +1,7 @@ /* - * Copyright (c) 2008 - 2009 + * Copyright (c) 2008 - 2010 * Jonathan Schleifer * * All rights reserved. * * This file is part of ObjFW. It may be distributed under the terms of the @@ -15,11 +15,11 @@ #include #import /** - * A result of a comparison. + * \brief A result of a comparison. */ typedef enum { /// The left object is smaller than the right OF_ORDERED_ASCENDING = -1, /// Both objects are equal @@ -27,11 +27,11 @@ /// The left object is bigger than the right OF_ORDERED_DESCENDING = 1 } of_comparison_result_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; @@ -289,24 +289,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