[fpc-pascal] SizeInt documentation

Michael Van Canneyt michael at freepascal.org
Mon Jun 22 18:08:20 CEST 2015



On Mon, 22 Jun 2015, J├╝rgen Hestermann wrote:

> Am 2015-06-21 um 20:16 schrieb leledumbo:
>>> A documenation of a type that has different meanings on different
>>> platforms should tell about this.
>>> That's what a documentation is for!
>> Well, the user guide, programmer's reference or basically everything other
>> than the API documentation mentions whenever something is platform 
> specific.
>> And they're hand written.
>
> Then I don't understand what the web page
> http://www.freepascal.org/docs-html/rtl/system/sizeint.html
> realy is.
> I thought it was an online documentation of the Free Pascal runtime library.
> Is it not?
> What is the API documentation you talk about?
> Free Pascal cannot be documented without the OS-specific details.
> Isn't the SIZEINT type a part of Free Pascal?
> Then a documentation has to tell all details about it.
> Otherwise it cannot be called documentation.
> But what is then?
>
>
>>> How should I know that these documentations are for *nix only?
>> *nix units are not available on non-nix platforms, it's that simple.
>
> When I search for "sizeint" in google I find
> http://www.freepascal.org/docs-html/rtl/system/sizeint.html
> What is unix-related here?
> It is a general documentation of the SIZEINT type.
> Not a single word about *nix.

SizeInt has nothing to do with the OS, everything with the CPU.

I have improved the documentation of SizeInt, it will be visible in the next release.

Michael.


More information about the fpc-pascal mailing list