<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN">
<html><body>
<p>Resending the email. The images are here:</p>
<p> </p>
<p><a href="http://imagebin.org/192019" target="_blank">http://imagebin.org/192019</a></p>
<p><a href="http://imagebin.org/192020" target="_blank">http://imagebin.org/192020</a></p>
<p><a href="http://imagebin.org/192021" target="_blank">http://imagebin.org/192021</a></p>
<p> </p>
<p>On 6 jan '12, dhkblaszyk@zeelandnet.nl 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 -->
<p>I checked doxygen (<a href="http://www.stack.nl/~dimitri/doxygen/examples/overload/html/class_test.html#a8e7b46ceaf7bd2ab94114b390b3288ca">http://www.stack.nl/~dimitri/doxygen/examples/overload/html/class_test.html#a8e7b46ceaf7bd2ab94114b390b3288ca</a>), but it does not seem to list the variables. Pasdoc does not seem to group overloaded functions, but rather list them separate in a table (<a href="http://pasdoc.sourceforge.net/autodoc/html/PasDoc_Gen.TDocGenerator.html#WriteConverted">http://pasdoc.sourceforge.net/autodoc/html/PasDoc_Gen.TDocGenerator.html#WriteConverted</a>)</p>
<p> </p>
<p>On a side note,</p>
<p>1) for overloaded functions it seems that only one result string is possible to define. As seen in the XML file:(no desitinction based on result type)</p>
<p>2) string variables or result types do not show in my documentation (as do more complex result types as arrays, please look to the screenshots) seems to be a bug??</p>
<p> </p>
<p>Anyway, I have created a mockup for a slightly modified result from fpdoc as seen in the screenshots. What has changed:</p>
<p> </p>
<p>1) All arguments are mixed into one table</p>
<p>2) The result types are also put in a result table (needs modification in the XML as described above)</p>
<p>3) initialized variables (style: integer = 0) are automatically added to the description eg (default = 0)</p>
<p> </p>
<p>A second mockup adds the argument and result type description as "comments" to the declaration section. This eliminates the need to have a variable section completely. It also adds the possibility to add different comments per overloaded function even on variable level. Personally I like the comments approach as it makes the documentation page nice and compact.</p>
<p> </p>
<p>Regards, Darius</p>
<p> </p>
<p> </p>
<blockquote style="padding-left: 5px; border-left: #1010ff 2px solid; margin-left: 5px; width: 100%;">
<blockquote style="padding-left: 5px; border-left: #1010ff 2px solid; margin-left: 5px; width: 100%;">When you have overloaded functions, fpdoc will group them on one page. The arguments however are listed in two separate arguments sections. It would be nice to have the arguments merged in one section. I do not know how to display the arguments though (no idea what others do like pasdoc or doxygen). Should only the unique arguments be shown (perhaps sorted alphabetically?), should there be a table with arguments per overloaded function?</blockquote>
<pre>It is already a table.</pre>
<blockquote style="padding-left: 5px; border-left: #1010ff 2px solid; margin-left: 5px; width: 100%;">More importantly, would a patch of this sort be approved? Can the authorities comment on this please? ;-)</blockquote>
<pre>If you find a nice solution: Of course. Maybe a single table will be more clear. Function results may be more difficult: Function A(b) : C; Function A(d) : E; But I agree that the current situation is not ideal. </pre>
</blockquote>
<p> </p>
<p> </p>
<div> </div>
</blockquote>
<p> </p>
<p> </p>
<div> </div>
</body></html>