ObjFW  Check-in [b9f69f358f]

Overview
Comment:Minor documentation fix
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | 1.0
Files: files | file ages | folders
SHA3-256: b9f69f358f4dae027f1a3a9f20f1a013d10fc604c46329582b04def33d8e738b
User & Date: js on 2024-03-02 21:20:29
Other Links: branch diff | manifest | tags
Context
2024-03-03
23:35
OFFileIRIHandler: Correctly transform exception check-in: 1829139db1 user: js tags: 1.0
2024-03-02
21:20
Minor documentation fix check-in: b9f69f358f user: js tags: 1.0
21:20
Minor documentation fix check-in: 7619af113a user: js tags: trunk
17:58
Fix documentation for mutable classes check-in: 06926ebe58 user: js tags: 1.0
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

Modified src/OFLHAArchive.h from [d2030f377f] to [064a650fc9].

︙︙
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164

 *
 * @note The uncompressed size, compressed size and CRC16 of the specified
 *	 entry are ignored.
 *
 * @note The returned stream conforms to @ref OFReadyForWritingObserving if the
 *	 underlying stream does so, too.
 *
 * @warning Calling @ref nextEntry will invalidate all streams returned by
 *	    @ref streamForReadingCurrentEntry or
 *	    @ref streamForWritingEntry:! Reading from or writing to an
 *	    invalidated stream will throw an @ref OFReadFailedException or
 *	    @ref OFWriteFailedException!
 *
 * @param entry The entry for which a stream for writing should be returned
 * @return A stream for writing the specified entry
 */








|
|








149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164

 *
 * @note The uncompressed size, compressed size and CRC16 of the specified
 *	 entry are ignored.
 *
 * @note The returned stream conforms to @ref OFReadyForWritingObserving if the
 *	 underlying stream does so, too.
 *
 * @warning Calling @ref streamForWritingEntry: will invalidate all streams
 *	    returned by @ref streamForReadingCurrentEntry or
 *	    @ref streamForWritingEntry:! Reading from or writing to an
 *	    invalidated stream will throw an @ref OFReadFailedException or
 *	    @ref OFWriteFailedException!
 *
 * @param entry The entry for which a stream for writing should be returned
 * @return A stream for writing the specified entry
 */
︙︙

Modified src/OFTarArchive.h from [aa075ebdff] to [b569fe9e96].

︙︙
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168

 * @brief Returns a stream for writing the specified entry.
 *
 * @note This is only available in write and append mode.
 *
 * @note The returned stream conforms to @ref OFReadyForWritingObserving if the
 *	 underlying stream does so, too.
 *
 * @warning Calling @ref nextEntry will invalidate all streams returned by
 *	    @ref streamForReadingCurrentEntry or
 *	    @ref streamForWritingEntry:! Reading from or writing to an
 *	    invalidated stream will throw an @ref OFReadFailedException or
 *	    @ref OFWriteFailedException!
 *
 * @param entry The entry for which a stream for writing should be returned
 * @return A stream for writing the specified entry
 */








|
|








153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168

 * @brief Returns a stream for writing the specified entry.
 *
 * @note This is only available in write and append mode.
 *
 * @note The returned stream conforms to @ref OFReadyForWritingObserving if the
 *	 underlying stream does so, too.
 *
 * @warning Calling @ref streamForWritingEntry: will invalidate all streams
 *	    returned by @ref streamForReadingCurrentEntry or
 *	    @ref streamForWritingEntry:! Reading from or writing to an
 *	    invalidated stream will throw an @ref OFReadFailedException or
 *	    @ref OFWriteFailedException!
 *
 * @param entry The entry for which a stream for writing should be returned
 * @return A stream for writing the specified entry
 */
︙︙