[Development] QDoc can't ignore Q_PROPERTY

Lincoln Ramsay lincoln.ramsay at nokia.com
Wed Mar 14 01:51:59 CET 2012


On 03/13/2012 07:04 AM, Vandonderen Casper (Nokia-MP/Oslo) wrote:
> The solution given above would mean that it will become optional to
> document NOTIFY signals. But is that not completely different from
> the original problem?

Yes.

The original question was how to make qdoc not see Q_PROPERTY 
(presumably because the OP didn't like what that did to the 
documentation). As far as I know, the "answer" to that is actually 
fairly simple:

#ifndef Q_QDOC
Q_PROPERTY(...)
#endif

To have the properties show up in the docs but to leave the 
documentation for the getters and setters in too, you'd need something 
like this:

#ifdef Q_QDOC
Q_PROPERTY(int myprop)
#else
Q_PROPERTY(int myprop READ myprop WRITE setMyprop)
#endif

However, I don't understand why you would want/need to do this.




Anyway, my first reply was a complaint about how you are forced to 
document NOTIFY signals and I guess at that point the thread was 
hijacked onto a separate topic.

-- 
Lincoln Ramsay - Senior Software Engineer
Qt Development Frameworks, Nokia - http://qt.nokia.com/



More information about the Development mailing list