After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 614438 - Doxygen produces bad documentation when using a template type for a property.
Doxygen produces bad documentation when using a template type for a property.
Status: VERIFIED FIXED
Product: doxygen
Classification: Other
Component: general
1.5.9
Other Linux
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2010-03-31 08:11 UTC by Lukas Sommer
Modified: 2010-08-01 10:09 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Lukas Sommer 2010-03-31 08:11:42 UTC
Doxygen produces bad documentation when using a template type for a property.

When you use a templete type (like QList<>) as type in a Qt property declaration, the resulting documentation uses the template itself as type and its argument as property name.

Example:

Q_PROPERTY(QList<radioStation *> selectedStreams READ selectedStreams)

results in the documentation:

QList stationlistModel::radioStation [read]

But it should be:

QList<radioStation *> stationlistModel::selectedStreams [read]

Note: Explicit links to the property (like "#selectedStreams") are passed without errors and create in the HTML output also a link - but clicking on this link doesn't has any effect.
Comment 1 Dimitri van Heesch 2010-04-10 13:42:16 UTC
Confirmed. I'll correct this in the next subversion update.
As a workaround you can use:

Q_PROPERTY(QList<radioStation*> selectedStreams READ selectedStreams)

which should already work.
Comment 2 Dimitri van Heesch 2010-06-15 11:21:31 UTC
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.7.0. Please verify if this is indeed the case. Reopen the
bug if you think it is not fixed and please include any additional information
that you think can be relevant.
Comment 3 Lukas Sommer 2010-08-01 10:09:34 UTC
Verified in 1.7.1. Everything works fine (including links). Thanks.

BTW: The new HTML design is great!