<html>
<head>
<meta content="text/html; charset=windows-1252"
http-equiv="Content-Type">
</head>
<body bgcolor="#FFFFFF" text="#000000">
Am 2015-06-21 um 16:25 schrieb leledumbo:<br>
<blockquote cite="mid:1434896717567-5721882.post@n5.nabble.com"
type="cite">
<blockquote type="cite">
<pre wrap="">but the documentation says that it is always Longint.
Can someone please correct this as it causes a lot of confusion.
</pre>
</blockquote>
<pre wrap="">fpdoc parser understands and interprets compiler directives, so it can't
display something that's defined differently for each platform. </pre>
</blockquote>
Then something is wrong with how the documentation is "generated"
(shouldn't it be written by a human?).<br>
A documenation of a type that has different meanings on different
platforms should tell about this. <br>
That's what a documentation is for! <br>
<br>
<br>
<blockquote cite="mid:1434896717567-5721882.post@n5.nabble.com"
type="cite">
<pre wrap="">As you can see, we have *nix units documented online/downloadable but the others don't.</pre>
</blockquote>
How should I know that these documentations are for *nix only? <br>
They don't say this anywhere.<br>
<br>
<br>
<blockquote cite="mid:1434896717567-5721882.post@n5.nabble.com"
type="cite">
<pre wrap="">The description can be used to explain further, but the source cannot.
example:
<a class="moz-txt-link-freetext" href="http://www.freepascal.org/docs-html/rtl/system/ptruint.html">http://www.freepascal.org/docs-html/rtl/system/ptruint.html</a>
the source still displays 32-bitism (= DWord), but the description says
bitness neutral explanation ("size of a pointer" is CPU dependent).
</pre>
</blockquote>
That is totally missleading and makes the "documentation" useless.<br>
It does not inform about all side effects which IMO is the purpose<br>
of a documentation. Otherwise I can also guess (and try).<br>
I would expect that the "source" part is manually written in the
same <br>
way as the "description" part.<br>
What is the use of writing contradicting statements like these into
a documentation:<br>
<br>
"Unsigned integer type with same size as Pointer."<tt><span
class="code"><span class="kw"><br>
and<br>
"type </span>PtrUInt<span class="sym"> = </span><a
href="http://www.freepascal.org/docs-html/rtl/system/dword.html">DWord</a><span
class="sym">;</span></span></tt>"<br>
<br>
What size is PtrUInt? The same as a pointer or DWord?<br>
They differ on 64 bit systems.<br>
<br>
Keep in mind that the documentation is for those people<br>
who do *NOT* know (for sure) what these types mean.<br>
All others would not read it anyway.<br>
<br>
</body>
</html>