FPDoc: Inconvenient documentation of overloaded functions, especially function results (HTML)
Original Reporter info from Mantis: warrence
-
Reporter name: Stefan Müller
Original Reporter info from Mantis: warrence
- Reporter name: Stefan Müller
Description:
I use FPDoc to generate the HTML output of a documentation for overloaded functions. At first I get a list of all different declarations of this function. After that the argument list and the function result for each alternative version of the function (i. e. argument list, function result, argument list, function result and so on).
Unfortunatly the XML description files do not support this, afaik: there is only one FPDoc element "functionname.result" within the XML, and "functionname" is obviously the same for all overloaded versions. Despite that, FPDoc nonetheless generates several "Function result" headings with the same description after each of the headings. I don't think that this makes sense.
My suggestion is, that either the multiple "Function result" headings are removed in the HTML output or that there is support for multiple function result tags.
Mantis conversion info:
- Mantis ID: 14843
- OS: Windows XP
- Platform: x86
- Version: 2.2.4
- Fixed in version: 3.0.0
- Fixed in revision: 21868 (#09374840)
- Target version: 2.6.1