Overview
Comment: | Make use of \warning in documentation. |
---|---|
Downloads: | Tarball | ZIP archive | SQL archive |
Timelines: | family | ancestors | descendants | both | trunk |
Files: | files | file ages | folders |
SHA3-256: |
a49eec5be44e02622eeb184d468976bd |
User & Date: | js on 2011-11-23 00:26:02 |
Other Links: | manifest | tags |
Context
2011-11-23
| ||
00:28 | Doxygen is picky about %. check-in: 0a87610175 user: js tags: trunk | |
00:26 | Make use of \warning in documentation. check-in: a49eec5be4 user: js tags: trunk | |
00:21 | Add an implementation of strptime. check-in: bfdf9135d3 user: js tags: trunk | |
Changes
Modified src/OFDataArray.h from [beb53a5545] to [7a97ff55a1].
︙ | ︙ | |||
140 141 142 143 144 145 146 | * \return The size of each item in the OFDataArray in bytes */ - (size_t)itemSize; /** * \brief Returns all elements of the OFDataArray as a C array. * | | | 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 | * \return The size of each item in the OFDataArray in bytes */ - (size_t)itemSize; /** * \brief Returns all elements of the OFDataArray as a C array. * * \warning The pointer is only valid until the OFDataArray is changed! * * Modifying the returned array directly is allowed and will change the contents * of the data array. * * \return All elements of the OFDataArray as a C array */ - (void*)cArray; |
︙ | ︙ |
Modified src/OFDate.h from [b7bf140a82] to [1931e7f5a9].
︙ | ︙ | |||
58 59 60 61 62 63 64 | * * The time zone used is UTC. If a time zone is specified anyway, an * OFInvalidFormatException is thrown. See +[dateWithLocalDateString:format:] * if you want to specify a time zone. * * See the manpage for strftime for information on the format. * | | | | | | 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 | * * The time zone used is UTC. If a time zone is specified anyway, an * OFInvalidFormatException is thrown. See +[dateWithLocalDateString:format:] * if you want to specify a time zone. * * See the manpage for strftime for information on the format. * * \warning The format is currently limited to the following format specifiers: * %d, %e, %H, %m, %M, %S, %y, %Y, %%, %n and %t. * * \param string The string describing the date * \param format The format of the string describing the date * \return A new, autoreleased OFDate with the specified date and time */ + dateWithDateString: (OFString*)string format: (OFString*)format; /** * \brief Creates a new OFDate with the specified string in the specified * format. * * If no time zone is specified, local time is assumed. * * See the manpage for strftime for information on the format. * * \warning The format is currently limited to the following format specifiers: * %d, %e, %H, %m, %M, %S, %y, %Y, %%, %n and %t. * * \param string The string describing the date * \param format The format of the string describing the date * \return A new, autoreleased OFDate with the specified date and time */ + dateWithLocalDateString: (OFString*)string format: (OFString*)format; |
︙ | ︙ | |||
132 133 134 135 136 137 138 | * * The time zone used is UTC. If a time zone is specified anyway, an * OFInvalidFormatException is thrown. See -[initWithLocalDateString:format:] * if you want to specify a time zone. * * See the manpage for strftime for information on the format. * | | | | | | 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 | * * The time zone used is UTC. If a time zone is specified anyway, an * OFInvalidFormatException is thrown. See -[initWithLocalDateString:format:] * if you want to specify a time zone. * * See the manpage for strftime for information on the format. * * \warning The format is currently limited to the following format specifiers: * %d, %e, %H, %m, %M, %S, %y, %Y, %%, %n and %t. * * \param string The string describing the date * \param format The format of the string describing the date * \return An initialized OFDate with the specified date and time */ - initWithDateString: (OFString*)string format: (OFString*)format; /** * \brief Initializes an already allocated OFDate with the specified string in * the specified format. * * If no time zone is specified, local time is assumed. * * See the manpage for strftime for information on the format. * * \warning The format is currently limited to the following format specifiers: * %d, %e, %H, %m, %M, %S, %y, %Y, %%, %n and %t. * * \param string The string describing the date * \param format The format of the string describing the date * \return An initialized OFDate with the specified date and time */ - initWithLocalDateString: (OFString*)string format: (OFString*)format; |
︙ | ︙ |
Modified src/OFStream.h from [10e2127f1f] to [73c72f5177].
︙ | ︙ | |||
20 21 22 23 24 25 26 | #import "OFString.h" @class OFDataArray; /** * \brief A base class for different types of streams. * | | | | | > | | | | | > | | 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 | #import "OFString.h" @class OFDataArray; /** * \brief A base class for different types of streams. * * \warning Even though the OFCopying protocol is implemented, it does * <i>not</i> return an independant copy of the stream but instead * retains it. This is so that the stream can be used as a key for a * dictionary so context can be associated with a stream. Using a * stream in more than one thread at the same time is not thread-safe, * even if copy was called! * * \warning If you want to subclass this, override _readNBytes:intoBuffer:, * _writeNBytes:fromBuffer: and _isAtEndOfStream, but nothing else. * Those are not defined in the headers, but do the actual work. * OFStream uses those and does all the caching and other stuff. If * you override these methods without the _ prefix, you *WILL* break * caching and get broken results! */ @interface OFStream: OFObject <OFCopying> { char *cache; char *writeBuffer; size_t cacheLength, writeBufferLength; BOOL buffersWrites; |
︙ | ︙ | |||
76 77 78 79 80 81 82 | * \brief Reads exactly the specified length bytes from the stream into a * buffer. * * Unlike readNBytes:intoBuffer:, this method does not return when less than the * specified length has been read - instead, it waits until it got exactly the * specified length. * | | | | | | | | | | | | | | | | | | | | | | | | | | 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 | * \brief Reads exactly the specified length bytes from the stream into a * buffer. * * Unlike readNBytes:intoBuffer:, this method does not return when less than the * specified length has been read - instead, it waits until it got exactly the * specified length. * * \warning Only call this when you know that specified amount of data is * available! Otherwise you will get an exception! * * \param buffer The buffer into which the data is read * \param length The length of the data that should be read. * The buffer MUST be EXACTLY this big! */ - (void)readExactlyNBytes: (size_t)length intoBuffer: (void*)buffer; /** * \brief Reads a uint8_t from the stream. * * \warning Only call this when you know that enough data is available! * Otherwise you will get an exception! * * \return A uint8_t from the stream */ - (uint8_t)readInt8; /** * \brief Reads a uint16_t from the stream which is encoded in big endian. * * \warning Only call this when you know that enough data is available! * Otherwise you will get an exception! * * \return A uint16_t from the stream in native endianess */ - (uint16_t)readBigEndianInt16; /** * \brief Reads a uint32_t from the stream which is encoded in big endian. * * \warning Only call this when you know that enough data is available! * Otherwise you will get an exception! * * \return A uint32_t from the stream in the native endianess */ - (uint32_t)readBigEndianInt32; /** * \brief Reads a uint64_t from the stream which is encoded in big endian. * * \warning Only call this when you know that enough data is available! * Otherwise you will get an exception! * * \return A uint64_t from the stream in the native endianess */ - (uint64_t)readBigEndianInt64; /** * \brief Reads a float from the stream which is encoded in big endian. * * \warning Only call this when you know that enough data is available! * Otherwise you will get an exception! * * \return A float from the stream in the native endianess */ - (float)readBigEndianFloat; /** * \brief Reads a double from the stream which is encoded in big endian. * * \warning Only call this when you know that enough data is available! * Otherwise you will get an exception! * * \return A double from the stream in the native endianess */ - (double)readBigEndianDouble; /** * \brief Reads the specified number of uint16_ts from the stream which are * encoded in big endian. * * \warning Only call this when you know that enough data is available! * Otherwise you will get an exception! * * \param nInt16s The number of uint16_ts to read * \param buffer A buffer of sufficient size to store the specified number of * uint16_ts * \return The number of bytes read */ - (size_t)readNBigEndianInt16s: (size_t)nInt16s intoBuffer: (uint16_t*)buffer; /** * \brief Reads the specified number of uint32_ts from the stream which are * encoded in big endian. * * \warning Only call this when you know that enough data is available! * Otherwise you will get an exception! * * \param nInt32s The number of uint32_ts to read * \param buffer A buffer of sufficient size to store the specified number of * uint32_ts * \return The number of bytes read */ - (size_t)readNBigEndianInt32s: (size_t)nInt32s intoBuffer: (uint32_t*)buffer; /** * \brief Reads the specified number of uint64_ts from the stream which are * encoded in big endian. * * \warning Only call this when you know that enough data is available! * Otherwise you will get an exception! * * \param nInt64s The number of uint64_ts to read * \param buffer A buffer of sufficient size to store the specified number of * uint64_ts * \return The number of bytes read */ - (size_t)readNBigEndianInt64s: (size_t)nInt64s intoBuffer: (uint64_t*)buffer; /** * \brief Reads the specified number of floats from the stream which are encoded * in big endian. * * \warning Only call this when you know that enough data is available! * Otherwise you will get an exception! * * \param nFloatss The number of floats to read * \param buffer A buffer of sufficient size to store the specified number of * floats * \return The number of bytes read */ - (size_t)readNBigEndianFloats: (size_t)nFloats intoBuffer: (float*)buffer; /** * \brief Reads the specified number of doubles from the stream which are * encoded in big endian. * * \warning Only call this when you know that enough data is available! * Otherwise you will get an exception! * * \param nDoubles The number of doubles to read * \param buffer A buffer of sufficient size to store the specified number of * doubles * \return The number of bytes read */ - (size_t)readNBigEndianDoubles: (size_t)nDoubles intoBuffer: (double*)buffer; /** * \brief Reads a uint16_t from the stream which is encoded in little endian. * * \warning Only call this when you know that enough data is available! * Otherwise you will get an exception! * * \return A uint16_t from the stream in native endianess */ - (uint16_t)readLittleEndianInt16; /** * \brief Reads a uint32_t from the stream which is encoded in little endian. * * \warning Only call this when you know that enough data is available! * Otherwise you will get an exception! * * \return A uint32_t from the stream in the native endianess */ - (uint32_t)readLittleEndianInt32; /** * \brief Reads a uint64_t from the stream which is encoded in little endian. * * \warning Only call this when you know that enough data is available! * Otherwise you will get an exception! * * \return A uint64_t from the stream in the native endianess */ - (uint64_t)readLittleEndianInt64; /** * \brief Reads a float from the stream which is encoded in little endian. * * \warning Only call this when you know that enough data is available! * Otherwise you will get an exception! * * \return A float from the stream in the native endianess */ - (float)readLittleEndianFloat; /** * \brief Reads a double from the stream which is encoded in little endian. * * \warning Only call this when you know that enough data is available! * Otherwise you will get an exception! * * \return A double from the stream in the native endianess */ - (double)readLittleEndianDouble; /** * \brief Reads the specified number of uint16_ts from the stream which are * encoded in little endian. * * \warning Only call this when you know that enough data is available! * Otherwise you will get an exception! * * \param nInt16s The number of uint16_ts to read * \param buffer A buffer of sufficient size to store the specified number of * uint16_ts * \return The number of bytes read */ - (size_t)readNLittleEndianInt16s: (size_t)nInt16s intoBuffer: (uint16_t*)buffer; /** * \brief Reads the specified number of uint32_ts from the stream which are * encoded in little endian. * * \warning Only call this when you know that enough data is available! * Otherwise you will get an exception! * * \param nInt32s The number of uint32_ts to read * \param buffer A buffer of sufficient size to store the specified number of * uint32_ts * \return The number of bytes read */ - (size_t)readNLittleEndianInt32s: (size_t)nInt32s intoBuffer: (uint32_t*)buffer; /** * \brief Reads the specified number of uint64_ts from the stream which are * encoded in little endian. * * \warning Only call this when you know that enough data is available! * Otherwise you will get an exception! * * \param nInt64s The number of uint64_ts to read * \param buffer A buffer of sufficient size to store the specified number of * uint64_ts * \return The number of bytes read */ - (size_t)readNLittleEndianInt64s: (size_t)nInt64s intoBuffer: (uint64_t*)buffer; /** * \brief Reads the specified number of floats from the stream which are * encoded in little endian. * * \warning Only call this when you know that enough data is available! * Otherwise you will get an exception! * * \param nFloats The number of floats to read * \param buffer A buffer of sufficient size to store the specified number of * floats * \return The number of bytes read */ - (size_t)readNLittleEndianFloats: (size_t)nFloats intoBuffer: (float*)buffer; /** * \brief Reads the specified number of doubles from the stream which are * encoded in little endian. * * \warning Only call this when you know that enough data is available! * Otherwise you will get an exception! * * \param nDoubles The number of doubles to read * \param buffer A buffer of sufficient size to store the specified number of * doubles * \return The number of bytes read */ - (size_t)readNLittleEndianDoubles: (size_t)nDoubles intoBuffer: (double*)buffer; /** * \brief Reads the specified number of items with an item size of 1 from the * stream and returns them in an OFDataArray. * * \warning Only call this when you know that enough data is available! * Otherwise you will get an exception! * * \param nItems The number of items to read * \return An OFDataArray with at nItems items. */ - (OFDataArray*)readDataArrayWithNItems: (size_t)nItems; /** * \brief Reads the specified number of items with the specified item size from * the stream and returns them in an OFDataArray. * * \warning Only call this when you know that enough data is available! * Otherwise you will get an exception! * * \param itemSize The size of each item * \param nItems The number of items to read * \return An OFDataArray with at nItems items. */ - (OFDataArray*)readDataArrayWithItemSize: (size_t)itemSize |
︙ | ︙ | |||
388 389 390 391 392 393 394 | * \brief Reads a string with the specified length from the stream. * * If a \\0 appears in the stream, the string will be truncated at the \\0 and * the rest of the bytes of the string will be lost. This way, reading from the * stream will not break because of a \\0 because the specified number of bytes * is still being read and only the string gets truncated. * | | | | 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 | * \brief Reads a string with the specified length from the stream. * * If a \\0 appears in the stream, the string will be truncated at the \\0 and * the rest of the bytes of the string will be lost. This way, reading from the * stream will not break because of a \\0 because the specified number of bytes * is still being read and only the string gets truncated. * * \warning Only call this when you know that enough data is available! * Otherwise you will get an exception! * * \param length The length (in bytes) of the string to read from the stream * \return A string with the specified length */ - (OFString*)readStringWithLength: (size_t)length; /** * \brief Reads a string with the specified encoding and length from the stream. * * If a \\0 appears in the stream, the string will be truncated at the \\0 and * the rest of the bytes of the string will be lost. This way, reading from the * stream will not break because of a \\0 because the specified number of bytes * is still being read and only the string gets truncated. * * \warning Only call this when you know that enough data is available! * Otherwise you will get an exception! * * \param encoding The encoding of the string to read from the stream * \param length The length (in bytes) of the string to read from the stream * \return A string with the specified length */ - (OFString*)readStringWithEncoding: (of_string_encoding_t)encoding |
︙ | ︙ |