[fpc-pascal] FPC docs wrong for TStream.WriteBuffer()

[michael.vancanneyt at wisa.be]

On Mon, 6 Feb 2012, Graeme Geldenhuys wrote:

>>
>> ReadBuffer actually reads data from the stream to the buffer. Just like
>> read.
>
> Sorry, I got my email all twisted - to many open windows at the same time.
>
>
> My issue is with the TStream.WriteBuffer's short description. It reads
> as follows...
>
>  "Writes data from the stream to the buffer"
>
>
> And now the Kylix 3 description of TStream.WriteBuffer.
>
>  "Writes Count bytes from Buffer onto the stream and advances
>  "the current position of the stream by Count bytes."
>
> As you can see, the FPC documentation describes the flow of data from
> the stream to the buffer parameter, but Kylix/Delphi describes it
> other way round - data from the Buffer is written to the Stream.
>
> In FPC's docs, the WriteBuffer and ReadBuffer short descriptions are
> saying the same thing. Suggesting a simple documentation
> copy-and-paste error.
>
>
> The correct short description for TStream.WriteBuffer should be
> something like...
>
>  "Writes data from the buffer to the stream"
>
> ...though the Kylix/Delphi short description is much better and clearer. :)

Correct. I've adapted the text. Rev 889.

Michael.