[Development] Missing documentation in Qt 5.12

Martin Smith Martin.Smith at qt.io
Wed Dec 19 13:38:48 CET 2018


I found the problem.

There are a few ways I can fix it. Which is preferred.

1. Simply merge the inherited members into the list that is already there.
2. Merge the inherited members into the list but qualified with their base class name.
3. list the inherited members from each base class all on the same page but separately for each base class.

QWidget members
...
QPaintDevice members
...
QObject members
...

________________________________________
From: Development <development-bounces at qt-project.org> on behalf of André Pönitz <apoenitz at t-online.de>
Sent: Tuesday, December 18, 2018 8:43:43 PM
To: Eike Ziller
Cc: Qt development mailing list
Subject: Re: [Development] Missing documentation in Qt 5.12

On Tue, Dec 18, 2018 at 11:49:22AM +0000, Eike Ziller wrote:
>
>
> > On Dec 18, 2018, at 11:25, Konstantin Shegunov <kshegunov at gmail.com>
> > wrote:
> >
> > On Tue, Dec 18, 2018 at 9:39 AM Martin Smith <Martin.Smith at qt.io>
> > wrote: I'll argue with you about it being a p1. If the problem is
> > confined to the all-members list, it's not a p1 problem because the
> > information is still there via the inherits links, which are more
> > useful for seeing what is inherited anyway.
> >
> > You can argue with the people that handled it through the tracker, I
> > don't prioritize bugs. From my point of view, however, it falls
> > strictly into the P1 category - it's a regression from the last
> > version, not an edge-case data loss, and it's pretty embarrassing.
> >
> > My own opinion is that the all-members list should be removed.
> >
> > I think no, unless there's another way to search for a method in the
> > hierarchy. Allowing for a somewhat contrived example: Say I'm
> > working with `QTemporaryFile` I know there exists something for
> > checking about it being readable but I don't know exactly from where
> > it comes from, then the all-members page is really useful. That
> > use-case gets even more prominent for classes that implement
> > interfaces and/or that have multiply inherited (e.g. QLabel's
> > indirect inheritance from QPaintDevice).
>
> This happens to me all the time with classes inheriting from IODevice,
> layouts like QHBoxLayout, and quite some widgets, where the useful
> methods are often spread through the whole hierarchy. Clicking up
> through the hierarchy works, but is not very efficient, the all
> members list is much more convenient.

Same here.

Especially for "feature discovery" one flat list is the best option.

Andre'
_______________________________________________
Development mailing list
Development at qt-project.org
https://lists.qt-project.org/listinfo/development



More information about the Development mailing list