type specifier does not work with namespace types
[Imported from GitHub]
- GitHub id: 51
- Author: Skycoder42
- Created at: 2019-09-27 06:09:40+00:00
If using the type like this:
/** type:MyNamespace::MyType The stuff */
property alias stuff: someObject.stuff
The generated documentation will be wrong. It shows only MyNamespace
as the type and the brief description instead reads ::MyType The stuff
.
This becomes relevant if a namespaced C++ class is registered in QML and used within QML. For my case, the example is a class named QtAutoUpdater::Updater
, which is registered in QML as de.skycoder42.QtAutoUpdater.Core.Updater
and used as follows:
/** type:QtAutoUpdater::Updater The updater */
property Updater updater: null
Not adding "type" will set the type to Updater
, which is not found by doxygen, as the namespace prefix is missing, and because the Updater
class lives in a different namespace than the QML class.
EDIT: This also applies when trying to reference Qt QML classes directly, i.e. QtQuick.Item
Comments
from agateau, 2019-10-20 17:33:56+00:00
Sorry for the super late answer. I am not active on this project right now, but I am happy to review PR if you feel like adding support for this.