Is there somewhere a list with all Qt macros in the documentation?

koahnig

Finding the proper documentation is especially painful for Qt macros e.g. QT_FORWARD_DECLARE_CLASS .

What is the trick to the documentation?

kshegunov

There's none. Usually you'd find these in the QtGlobal header's documentation, but some are spread over. Specifically QT_FORWARD_DECLARE_CLASS is not really for you (i.e. as a user programmer) to use, it's for Qt. You should hardcode the Qt namespace if you decide to use it, as using it is both binary and source incompatible with not using it.

koahnig

@kshegunov

Thanks for feedback.

I am trying to understand some Qt classes for some other implementation in a similar matter.

kshegunov

@koahnig said in Is there somewhere a list with all Qt macros in the documentation?:

I am trying to understand some Qt classes for some other implementation in a similar matter.

Then you're stuck decoding the private classes. If someone documented them (and/or the macros) then you're in luck, otherwise it's really up to you.

koahnig

@kshegunov

Thanks for the encouragement. Looked like an easy route for complete different implementation.

JKSH

@koahnig It's not documentation, but F2 in Qt Creator is very useful for figuring out a macro.

Also, if it's a public macro (like Q_DECLARE_METATYPE), then you can use a search engine by adding site:doc.qt.io/qt-5 to the search: https://www.google.com/search?q=site%3Adoc.qt.io%2Fqt-5%2F+Q_DECLARE_METATYPE (or use the browser extension at https://forum.qt.io/topic/35616/ )

koahnig

@JKSH

Thanks, yes I am aware of this possibility in creator.

IIRC I had encouraged you to publish the browser extension for Chrome. Great tool! Basically use it all the time.

I have stumbled across a couple of macros without a trace of documentation. Personally I consider as a pity.