[fpc-pascal] fpdoc and overloaded functions.
Michael Van Canneyt
michael at freepascal.org
Wed Sep 13 15:58:13 CEST 2006
On Wed, 13 Sep 2006, Graeme Geldenhuys wrote:
> What is the best way to document overloaded functions using fpdoc?
> For example, I have a Find function which has been overloaded four
> times with different parameters. Looking in the generated *.xml file,
> I only have one Find element, followed by all the different
> parameters, each in there own element node.
> In my previous documenting system, I had a different description for
> each Find method. With fpdoc, I can only have one. I thought if I
> documented the parameters, the html output might be what I wanted, but
> it isn't.
> See the link below to help explain what I mean:
> 1. How do I get a different description for each overloaded Find method.
> 2. Why is the title "Arguments" repeated. (Note I only documented the
> first two Find methods as an example). I normally don't document the
> functions, I rather mention them in the function description.
This is a bug; I should check that.
> 3. Is there no other way (html layout) so the arguments are easier to
> match there respected overloaded functions. Currently it is difficult
> to see what argument relates to what overloaded function.
Normally, the short description of the argument is displayed in the
declaration of the function. This seems not to be so anymore, I will
have to look at that.
More information about the fpc-pascal