Bug 183609

Summary:	Interpret doxygen tags in code browser and tooltips
Product:	[Applications] kdevelop	Reporter:	Thomas McGuire <mcguire>
Component:	Doxygen integration	Assignee:	kdevelop-bugs-null
Status:	RESOLVED FIXED
Severity:	wishlist	CC:	mihai.stanescu, post
Priority:	NOR
Version:	unspecified
Target Milestone:	---
Platform:	Compiled Sources
OS:	Unspecified
Latest Commit:		Version Fixed In:	5.0.0
Sentry Crash Report:
Attachments:	Screenshot showing doxygen-style comments in tooltip under KDevelop 5.0

Description Thomas McGuire 2009-02-07 21:51:58 UTC

Version:            (using KDE 4.2.0)
Installed from:    Compiled From Sources

Currently, the raw doxygen tags/commands appear in the code browser and in the tooltip, which doesn't look so nice.

It would be cool if KDevelop would interpret them, e.g. instead of "@param foo", it would say "Parameter foo:", and maybe make "Parameter" bold.
Same for a lot of other commands, like @since, @author, @return, @b etc.
A complete list can be found at http://www.stack.nl/~dimitri/doxygen/commands.html, but I'd say the most common ones, like the ones appearing in the KDE API docs, are enough.

Comment 1 Andreas Pakulat 2009-02-08 00:22:41 UTC

I don't like the idea of parsing doxygen comments, this means yet another parser which we have to maintain. Even just copying doxygen sources is a bad option, we had that in kdev3 and its a nightmare. So the only option I can see would be some way of running doxygen on a single tag and displaying the html result.

Comment 2 Kevin Funk 2012-12-22 23:58:07 UTC

*** Bug 232829 has been marked as a duplicate of this bug. ***

Comment 3 Kevin Funk 2016-07-12 15:34:52 UTC

We support this in KDevelop 5 now, the parsing of the doxygen-style comments is done by libclang.

Comment 4 Kevin Funk 2016-07-12 15:35:44 UTC

Created attachment 100037 [details]
Screenshot showing doxygen-style comments in tooltip under KDevelop 5.0

Comment 5 Volker Wysk 2016-07-12 15:49:34 UTC

It would be even better, if the doxygen tags would also be rendered in the source code browser window. When the cursor is outside the doxygen comment block, it would be nicely rendered. When it is inside, the plain text would be shown, which you could edit.

Comment 6 Kevin Funk 2016-07-12 15:59:47 UTC

@Volker: That would be a separate wish/report. I'm not sure that's feasible to implement; this would need support from the KTextEditor framework.