QML QDoc grouping property into one explanation

[The friendly stranger]

Hi everyone!

I have made my documentation for my qml library. It works well but I am missing a minor feature.

Is it possible to group my explanation for several properties at the same time ? For instance, I want to do the same as Item from QtQuick with the childrenRect properties.

\group and \ingroup aren't made for that purpose so I don't know which keyword I should use. I already read the Qt doc but I probably missed what I am looking for.

Thank you and have a good day!

[GrecKo]

It seems that before you needed to use \qqmlpropertygroup but it appears to not be necessary anymore : https://codereview.qt-project.org/c/qt/qtquickcontrols2/+/320620 (since Qt 5.13). Here is an example of a group property without it : https://github.com/qt/qtquickcontrols2/blob/HEAD/src/quicktemplates2/qquickrangeslider.cpp#L827-L834

[The friendly stranger]

@GrecKo said in QML QDoc grouping property into one explanation:

\qqmlpropertygroup

Thank you for your answer. From what I read, I understand that you can make a group only if my properties belong to the same object (for instance childrenRect or first/second with the rangeSlider).

In my case, I have 2 separated properties but I would like to have the same result on the doc. Using you example, I tried this:

/*! 
    \qmlproperty QtObject MyModule::MyControl::axisX
    \qmlproperty QtObject MyModule::MyControl::axisY
	
    axisX and axisY are QtObjects that use the following properties ...
*/
	property var axisX: null;
	property var axisY: null;

and I got

My explanations are repeated for each variable. Honestly, I can live with this result but I am all opened for a solution in case I make a long documentation

[The friendly stranger]

Still looking for a solution