[Development] [docs] changing the way overloads are documented and presented

Joerg Bornemann joerg.bornemann at qt.io
Tue May 2 09:57:27 CEST 2017


On 28/04/2017 09:35, Marc Mutz wrote:

> TL;DR: I propose to document overloaded functions with a single comment block,
> containing multiple \fn's and a common documentation text, to be rendered as
> one documentation block preceded by a listing of all the \fn's, instead of as
> individual functions.

+1

The text duplication is silly, and I have seen several places where 
information was inadvertently added to only one of the overloads.


BR,

Joerg



More information about the Development mailing list