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

[Martin Smith]

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

We still need a way to tell qdoc how to provide information that applies to one overload, or to a subset of the \fn overloads in the list.

martin
________________________________________
From: Development <development-bounces+martin.smith=qt.io at qt-project.org> on behalf of Joerg Bornemann <joerg.bornemann at qt.io>
Sent: Tuesday, May 2, 2017 9:57:27 AM
To: Marc Mutz; development at qt-project.org
Subject: Re: [Development] [docs] changing the way overloads are documented and presented

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
_______________________________________________
Development mailing list
Development at qt-project.org
http://lists.qt-project.org/mailman/listinfo/development