Bug#415246: qt4-doc: QT >= 4.2 documentation suggestions

[Jerome Vizcaino <vizcaino_jerome@yahoo.fr>]

Package: qt4-doc
Version: 4.2.2-1
Severity: minor

Hi,

I'd like to see two things added to the Qt4 documentation. This doesn't 
concern the debian package but upstream maintainers (sorry I couldn't figure 
out how to contact them directly).

The problem conerns QueuedConnection signal/slot connections. The 
documentation goes pretty fast on this and could be a little more precise.

First problem is that QueuedConnection are implemented using QEvent so people 
using queued connections must be very careful that their receiver objects 
handle events correctly. In my case, it took 2 days to find out that my 
receiver object was not handling any queued signals properly because my 
event() function was not returning QObject::event(evt) on unhandled events. 
Although that was clearly my fault, the only way I could figure this out was 
by debugging the full program using Qt debug build and sources... Not a 
simple task. Warning could be added to the documentation in order to avoid 
such caveats.

Second thing is about qRegisterMetaType and stuff. Documentation is not very 
clear on how this has to be done. I mean, the const char* param has to be the 
exact (case sensitive) name of the type you want to declare. This is not 
really obvious when you read the doc.

Last thing is about how copy is performed on params of a queued signal. 
Although this is clearly written in the doc, it does not state how the copy 
is performed (copy contructor ? , operator= ?). As far as QObjects are used 
this is no problem but if you want to use you own classes (without any 
relation to QObject) this is a bit tricky. This could be explained a little 
more.

Anyway, the doc is excellent and should be an example for most open-source 
APIs.

Keep up the good work.

Thank you

Jerome

-- System Information:
Debian Release: 4.0
  APT prefers unstable
  APT policy: (500, 'unstable')
Architecture: i386 (i686)
Shell:  /bin/sh linked to /bin/bash
Kernel: Linux 2.6.18-4-686
Locale: LANG=en_US.utf8, LC_CTYPE=en_US.utf8 (charmap=UTF-8) (ignored: LC_ALL
set to en_US.utf8)

-- no debconf information

	

	
		
___________________________________________________________________________ 
Yahoo! Mail réinvente le mail ! Découvrez le nouveau Yahoo! Mail et son interface révolutionnaire.
http://fr.mail.yahoo.com