Differences From Artifact [7b8537b8d6]:
- File
src/OFObject.h
— part of check-in
[0c3c3b6efa]
at
2024-05-01 15:19:55
on branch trunk
— Document a lot of undocumented functions & macros
Also fixes Doxygen not creating documentation for `static OF_INLINE`
functions. (user: js, size: 45047) [annotate] [blame] [check-ins using] [more...]
To Artifact [036e696929]:
- File src/OFObject.h — part of check-in [164f2fb4bf] at 2024-06-17 21:08:05 on branch trunk — Always use <ObjFW/ObjFW.h> in documentation (user: js, size: 45014) [annotate] [blame] [check-ins using]
︙ | ︙ | |||
99 100 101 102 103 104 105 | OFByteOrderNative = OFByteOrderBigEndian #else OFByteOrderNative = OFByteOrderLittleEndian #endif } OFByteOrder; /** | | | 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 | OFByteOrderNative = OFByteOrderBigEndian #else OFByteOrderNative = OFByteOrderLittleEndian #endif } OFByteOrder; /** * @struct OFRange OFObject.h ObjFW/ObjFW.h * * @brief A range. */ typedef struct OF_BOXABLE OFRange { /** The start of the range */ size_t location; /** The length of the range */ |
︙ | ︙ | |||
150 151 152 153 154 155 156 | /** * @brief A time interval in seconds. */ typedef double OFTimeInterval; /** | | | 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 | /** * @brief A time interval in seconds. */ typedef double OFTimeInterval; /** * @struct OFPoint OFObject.h ObjFW/ObjFW.h * * @brief A point in 2D space. */ typedef struct OF_BOXABLE OFPoint { /** The x coordinate of the point */ float x; /** The y coordinate of the point */ |
︙ | ︙ | |||
196 197 198 199 200 201 202 | if (point1.y != point2.y) return false; return true; } /** | | | 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 | if (point1.y != point2.y) return false; return true; } /** * @struct OFSize OFObject.h ObjFW/ObjFW.h * * @brief A size. */ typedef struct OF_BOXABLE OFSize { /** The width of the size */ float width; /** The height of the size */ |
︙ | ︙ | |||
242 243 244 245 246 247 248 | if (size1.height != size2.height) return false; return true; } /** | | | 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 | if (size1.height != size2.height) return false; return true; } /** * @struct OFRect OFObject.h ObjFW/ObjFW.h * * @brief A rectangle. */ typedef struct OF_BOXABLE OFRect { /** The point from where the rectangle originates */ OFPoint origin; /** The size of the rectangle */ |
︙ | ︙ | |||
293 294 295 296 297 298 299 | if (!OFEqualSizes(rect1.size, rect2.size)) return false; return true; } /** | | | 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 | if (!OFEqualSizes(rect1.size, rect2.size)) return false; return true; } /** * @struct OFVector3D OFObject.h ObjFW/ObjFW.h * * @brief A vector in 3D space. */ typedef struct OF_BOXABLE OFVector3D { /** The x coordinate of the vector */ float x; /** The y coordinate of the vector */ |
︙ | ︙ | |||
345 346 347 348 349 350 351 | if (vector1.z != vector2.z) return false; return true; } /** | | | 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 | if (vector1.z != vector2.z) return false; return true; } /** * @struct OFVector4D OFObject.h ObjFW/ObjFW.h * * @brief A vector in 4D space. */ typedef struct OF_BOXABLE OFVector4D { /** The x coordinate of the vector */ float x; /** The y coordinate of the vector */ |
︙ | ︙ | |||
459 460 461 462 463 464 465 | static const size_t OFNotFound = SIZE_MAX; @class OFMethodSignature; @class OFString; @class OFThread; /** | | | 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 | static const size_t OFNotFound = SIZE_MAX; @class OFMethodSignature; @class OFString; @class OFThread; /** * @protocol OFObject OFObject.h ObjFW/ObjFW.h * * @brief The protocol which all root classes implement. */ @protocol OFObject /** * @brief Returns the class of the object. * |
︙ | ︙ | |||
678 679 680 681 682 683 684 | * * @return Whether a weak reference to this object has been retained */ - (bool)retainWeakReference; @end /** | | | 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 | * * @return Whether a weak reference to this object has been retained */ - (bool)retainWeakReference; @end /** * @class OFObject OFObject.h ObjFW/ObjFW.h * * @brief The root class for all other classes inside ObjFW. */ OF_ROOT_CLASS @interface OFObject <OFObject> { @private |
︙ | ︙ | |||
1338 1339 1340 1341 1342 1343 1344 | * @param selector The selector not understood by the receiver * @throw OFNotImplementedException */ - (void)doesNotRecognizeSelector: (SEL)selector OF_NO_RETURN; @end /** | | | | | 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 | * @param selector The selector not understood by the receiver * @throw OFNotImplementedException */ - (void)doesNotRecognizeSelector: (SEL)selector OF_NO_RETURN; @end /** * @protocol OFCopying OFObject.h ObjFW/ObjFW.h * * @brief A protocol for the creation of copies. */ @protocol OFCopying /** * @brief Copies the object. * * For classes which can be immutable or mutable, this returns an immutable * copy. If only a mutable version of the class exists, it creates a mutable * copy. * * @return A copy of the object */ - (id)copy; @end /** * @protocol OFMutableCopying OFObject.h ObjFW/ObjFW.h * * @brief A protocol for the creation of mutable copies. * * This protocol is implemented by objects that can be mutable and immutable * and allows returning a mutable copy. */ @protocol OFMutableCopying /** * @brief Creates a mutable copy of the object. * * @return A mutable copy of the object */ - (id)mutableCopy; @end /** * @protocol OFComparing OFObject.h ObjFW/ObjFW.h * * @brief A protocol for comparing objects. * * This protocol is implemented by objects that can be compared. Its only * method, @ref compare:, should be overridden with a stronger type. */ @protocol OFComparing |
︙ | ︙ |