[Development] QDoc can't ignore Q_PROPERTY
lincoln.ramsay at nokia.com
Mon Mar 12 02:24:24 CET 2012
On 03/12/2012 10:05 AM, ext andrew.den-exter at nokia.com wrote:
>> This change only affects signals marked as NOTIFY in a Q_PROPERTY
> I think the point is there may be instances where a signal that is
> emitted incidentally when a property changes is used as the notify
> signal for that property.
Smells like bad design to me...
> I get not wanting to be forced into writing redundant 'emitted when
> this property has changed' documentation but excluding documentation
> that has been written for a signal seems a bit excessive, wouldn't it
> be enough to just omit the warning for an undocumented signal if it's
> a notify signal?
That would work but the code to do that would be more complicated (can't
just suppress warnings, must do "document as property" or "document as
signal" depending on if the signal docs are found). Since I don't
actually know the qdoc code, I went for a simple fix.
If the above design pattern (co-opting a signal for NOTIFY) is common
and suppressing the documentation for those signals will be a problem
then I guess the more complicated fix will need to be done.
Lincoln Ramsay - Senior Software Engineer
Qt Development Frameworks, Nokia - http://qt.nokia.com/
More information about the Development