New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doxygen produces bad documentation when using a template type for a property. (Origin: bugzilla #614438) #3719

Closed
doxygen opened this Issue Jul 2, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

status VERIFIED severity normal in component general for ---
Reported in version 1.5.9 on platform Other
Assigned to: Dimitri van Heesch

On 2010-03-31 08:11:42 +0000, Lukas Sommer wrote:

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.

On 2010-04-10 13:42:16 +0000, Dimitri van Heesch wrote:

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.

On 2010-06-15 11:21:31 +0000, Dimitri van Heesch wrote:

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.

On 2010-08-01 10:09:34 +0000, Lukas Sommer wrote:

Verified in 1.7.1. Everything works fine (including links). Thanks.

BTW: The new HTML design is great!

@doxygen doxygen closed this Jul 19, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment