ObjFW  Check-in [bb281804a3]

Overview
Comment:Fix the last Doxygen warnings
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256: bb281804a37d7a025f2a3ab1aafcd9ec1b867d20860ac680b17e20fa79441d12
User & Date: js on 2017-11-18 19:14:32
Other Links: manifest | tags
Context
2017-11-19
11:04
Do not conform to OFReadyFor*Observing by default check-in: 69749b6a5b user: js tags: trunk
2017-11-18
19:14
Fix the last Doxygen warnings check-in: bb281804a3 user: js tags: trunk
18:58
Doxyfile: Add OF_KINDOF check-in: 6f1f7794a8 user: js tags: trunk
Changes

Modified src/OFArray.h from [7014b0da9d] to [d737b0d1df].

384
385
386
387
388
389
390
391

392
393
394
395
396
397
398
384
385
386
387
388
389
390

391
392
393
394
395
396
397
398







-
+







			withObject: (nullable id)object;

/*!
 * @brief Returns a copy of the array sorted using the specified selector and
 *	  options.
 *
 * @param selector The selector to use to sort the array. It's signature
 *		   should be the same as that of @ref compare:.
 *		   should be the same as that of @ref OFComparing#compare:.
 * @param options The options to use when sorting the array.@n
 *		  Possible values are:
 *		  Value                      | Description
 *		  ---------------------------|-------------------------
 *		  `OF_ARRAY_SORT_DESCENDING` | Sort in descending order
 * @return A sorted copy of the array
 */

Modified src/OFDictionary.h from [19f6d1e56d] to [3063982b16].

226
227
228
229
230
231
232
233
234


235
236
237
238
239
240
241
226
227
228
229
230
231
232


233
234
235
236
237
238
239
240
241







-
-
+
+








/*!
 * @brief Sets a value for a key.
 *
 * If the key starts with an `@`, the `@` is stripped and
 * `[super setValue:forKey:]` is called.
 * If the key does not start with an `@`, this is equivalent to
 * @ref setObject:forKey:. In this case, if the dictionary is immutable, an
 * @ref OFUndefinedKeyException is thrown.
 * OFMutableDictionary#setObject:forKey:. In this case, if the dictionary is
 * immutable, an @ref OFUndefinedKeyException is thrown.
 *
 * @param key The key to set
 * @param value The value to set the key to
 */
- (void)setValue: (id)value
	  forKey: (OFString *)key;

Modified src/OFMutableArray.h from [1118eb94b2] to [a2d8b4645b].

195
196
197
198
199
200
201
202

203
204
205
206
207
208
209
195
196
197
198
199
200
201

202
203
204
205
206
207
208
209







-
+







 */
- (void)sort;

/*!
 * @brief Sorts the array using the specified selector and options.
 *
 * @param selector The selector to use to sort the array. It's signature
 *		   should be the same as that of @ref compare:.
 *		   should be the same as that of @ref OFComparing#compare:.
 * @param options The options to use when sorting the array.@n
 *		  Possible values are:
 *		  Value                      | Description
 *		  ---------------------------|-------------------------
 *		  `OF_ARRAY_SORT_DESCENDING` | Sort in descending order
 */
- (void)sortUsingSelector: (SEL)selector

Modified src/OFObject.h from [4bd56fc717] to [44d3bd5e78].

1133
1134
1135
1136
1137
1138
1139
1140

1141
1142
1143
1144
1145
1146
1147
1133
1134
1135
1136
1137
1138
1139

1140
1141
1142
1143
1144
1145
1146
1147







-
+







/*!
 * @protocol OFComparing OFObject.h ObjFW/OFObject.h
 *
 * @brief A protocol for comparing objects.
 *
 * This protocol is implemented by objects that can be compared.
 */
@protocol OFComparing <OFObject>
@protocol OFComparing
/*!
 * @brief Compares the object with another object.
 *
 * @param object An object to compare the object to
 * @return The result of the comparison
 */
- (of_comparison_result_t)compare: (id <OFComparing>)object;