<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN">

<html><body>

<p>On 1 okt '12, Reinier Olislagers wrote:</p>

<blockquote type="cite" style="padding-left:5px; border-left:#1010ff 2px solid; margin-left:5px; width:100%"><!-- html ignored --><!-- head ignored --><!-- meta ignored -->

<pre>On 1-10-2012 13:55, <a href="mailto:dhkblaszyk-47ckw973qWsGTViba+RHyw@public.gmane.org">dhkblaszyk-47ckw973qWsGTViba+RHyw@public.gmane.org</a>wrote:</pre>

<blockquote type="cite" style="padding-left:5px; border-left:#1010ff 2px solid; margin-left:5px; width:100%">On 1 okt '12, <a href="mailto:michael.vancanneyt-0Is9KJ9Sb0A@public.gmane.org">michael.vancanneyt-0Is9KJ9Sb0A@public.gmane.org</a>wrote:

<blockquote type="cite" style="padding-left:5px; border-left:#1010ff 2px solid; margin-left:5px; width:100%">On Mon, 1 Oct 2012, <a href="mailto:dhkblaszyk@zeelandnet.nl">dhkblaszyk@zeelandnet.nl</a>dhkblaszyk-47ckw973qWsGTViba+RHyw@public.gmane.org>wrote:

<blockquote type="cite" style="padding-left:5px; border-left:#1010ff 2px solid; margin-left:5px; width:100%">Hi Tomas, Thanks for clarifying. I will use PtrUInt to store the pointer address in. BTW: the documentation it says not to use PtrInt because it's signed and therefore smaller than a pointer (as in max value). Also there seems to be an error in the documentation. On <a href="http://www.freepascal.org/docs-html/rtl/system/ptruint.html">http://www.freepascal.org/docs-html/rtl/system/ptruint.html</a> [4] it is described that PtrUInt is an alias to DWord. However, it depends on the architecture which type it actually is. Could someone please correct the docs?</blockquote>

What do you want to see corrected ? On 32-bit systems, it is a DWord. The docs were generated on such a system, so you get this definition.</blockquote>

If possible I would like to see a remark mentioning that it's a QWord on 64bit and Word on 16bit. That by itself would make thing clearer already.</blockquote>

<pre>That sounds good (vaguely remember that PtrUint also depends on OS, but

leaving it to more knowledgeable people to updat the docs anyway)</pre>

<blockquote type="cite" style="padding-left:5px; border-left:#1010ff 2px solid; margin-left:5px; width:100%">In the ideal case fpdoc should be adjusted so it can handle these defines. However this will be very complex I assume.</blockquote>

<pre>IIUC, size PtrUint varies by architecture, which is more or less the

point of PtrUint.

Having this variation documented as Darius suggested above makes things

much clearer, because the programmer may be working on one platform and

programming for another (with {$IFDEFS}...).

Letting fpdoc predict this seems like a way to madness.

_______________________________________________

fpc-pascal maillist  -  <a href="mailto:fpc-pascal@lists.freepascal.org">fpc-pascal@lists.freepascal.org</a>

<a href="http://lists.freepascal.org/mailman/listinfo/fpc-pascal">http://lists.freepascal.org/mailman/listinfo/fpc-pascal</a>

</pre>

</blockquote>

<p>Nah, I wasn't thinking about letting fpdoc predict anything. Instead though it would be nice to introduce something that helps the documenter flag a certain piece of code and let fpdoc know that it should show alternatives or instead a separate piece of code (similar as examples does).</p>

<p> </p>

<p>Darius</p>

<p> </p>

<div> </div>

</body></html>