X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3c4f71cc3d63fb7bdfbd6cec3e39c8a8679f3e60..3201a1046ba71ba8e5ef2ed694fde34d12f743f3:/interface/stream.h diff --git a/interface/stream.h b/interface/stream.h index db8f227efe..532ac2d28d 100644 --- a/interface/stream.h +++ b/interface/stream.h @@ -217,7 +217,7 @@ public: The position is counted from the end of the stream. - @returns Upon successful completion, it returns the new offset as + @return Upon successful completion, it returns the new offset as measured in bytes from the beginning of the stream. Otherwise, it returns wxInvalidOffset. */ @@ -256,7 +256,7 @@ public: it gives you the position in the @e real stream counted from the start of the stream. - @returns Returns the current position in the stream if possible, + @return Returns the current position in the stream if possible, wxInvalidOffset in the other case. */ off_t Tell() const; @@ -332,7 +332,7 @@ public: @param mode One of wxFromStart, wxFromEnd, wxFromCurrent. - @returns The new stream position or wxInvalidOffset on error. + @return The new stream position or wxInvalidOffset on error. */ off_t SeekO(off_t pos, wxSeekMode mode = wxFromStart); @@ -634,7 +634,7 @@ public: Reads data from the input queue and stores it in the specified output stream. The data is read until an error is raised by one of the two streams. - @returns This function returns a reference on the current object, so the + @return This function returns a reference on the current object, so the user can test any states of the stream right away. */ wxInputStream Read(void* buffer, size_t size); @@ -652,7 +652,7 @@ public: @param mode One of wxFromStart, wxFromEnd, wxFromCurrent. - @returns The new stream position or wxInvalidOffset on error. + @return The new stream position or wxInvalidOffset on error. */ off_t SeekI(off_t pos, wxSeekMode mode = wxFromStart); @@ -725,7 +725,7 @@ public: (this is always the case for socket streams for example), returns @c wxInvalidOffset. - @wxsince{2.5.4} + @since 2.5.4 */ wxFileOffset GetLength() const;