Bug 251050 - Use doxygen comments on documentation hover
Summary: Use doxygen comments on documentation hover
Status: REOPENED
Alias: None
Product: CDT
Classification: Tools
Component: cdt-editor (show other bugs)
Version: 5.0.1   Edit
Hardware: PC Windows XP
: P3 enhancement with 28 votes (vote)
Target Milestone: ---   Edit
Assignee: Project Inbox CLA
QA Contact: Jonah Graham CLA
URL:
Whiteboard:
Keywords: helpwanted
: 464440 (view as bug list)
Depends on:
Blocks:
 
Reported: 2008-10-16 04:29 EDT by Fredric Moestedt CLA
Modified: 2020-09-04 15:22 EDT (History)
14 users (show)

See Also:


Attachments
Custom plug-in with additional hover "declaration" (24.87 KB, application/x-zip-compressed)
2018-06-13 08:06 EDT, Harald CLA
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Fredric Moestedt CLA 2008-10-16 04:29:18 EDT
It would be very useful if it would be possible to use the doxygen tags for the editor hover functionality (text hover name Documentation) just like it is implemented for javadoc.
Generally, doxygen comments for functions are added in the declaration for public functions (e.g. in the header file) and in the implementation for static functions (in the source file). If it's possible it would be great if the documentation engine should be aware of the doxygen comments even if only added on the declaration.
Comment 1 John CLA 2008-10-28 20:14:13 EDT
I second this request.
Comment 2 thamurath CLA 2009-10-21 03:31:43 EDT
Doxygen syntax is very similar to javadoc's so I think the javadoc module for eclipse could be a good place to start.
It would be very interesting if cdt has a documentation integration as javadoc for Java ...
Comment 3 Tim CLA 2010-01-19 04:02:50 EST
I'm surprised this is not already in CDT, it seems so logical.

Is there any way to extend CDT to make this possible?
Comment 4 Anton Leherbauer CLA 2010-02-22 03:50:57 EST
I added the keyword "helpwanted".
In contrast to Java, there is not the one and only documentation system for C/C++, which makes tooling support much more difficult.
Comment 5 Johannes Wienke CLA 2010-04-12 15:36:53 EDT
Couldn't this be merged with bug 180141?
Comment 6 Fredric Moestedt CLA 2010-07-22 03:58:05 EDT
(In reply to comment #5)
> Couldn't this be merged with bug 180141?

Yes. Seems like the same thing.
Comment 7 Anton Leherbauer CLA 2013-04-19 06:53:36 EDT

*** This bug has been marked as a duplicate of bug 180141 ***
Comment 8 Nathan Ridge CLA 2015-04-11 16:01:57 EDT
I think it would make sense to track this separately from bug 180141; that concerns content assist, while this concerns hovers.
Comment 9 Nathan Ridge CLA 2016-10-16 01:09:55 EDT
*** Bug 464440 has been marked as a duplicate of this bug. ***
Comment 10 Nathan Ridge CLA 2016-12-27 22:42:44 EST
Reopening per comment 8.
Comment 11 Harald CLA 2018-06-13 08:06:36 EDT
Created attachment 274456 [details]
Custom plug-in with additional hover "declaration"

In my opinion it's not a bug when the hover called "source" prefers to show the source definition. Therefore we created a plug-in that adds an hover called "declaration". This hover is a clone of the CDT "source" hover, that preferes to show the declaration. 

The new hover supports less elements than the "source" hover. The "source" hover should not be deactivated to get full hover support for all selectable elements. 

I've added this FYI. 

PS: There are some dependencies to internal CDT8 classes.
Comment 12 Nathan Ridge CLA 2018-06-13 13:17:12 EDT
(In reply to Harald    from comment #11)
> This hover is a clone of the CDT "source" hover, that
> preferes to show the declaration. 

Are you interested in contributing this functionality to CDT?
Comment 13 Harald CLA 2018-06-15 07:40:47 EDT
(In reply to Nathan Ridge from comment #12)
> 
> Are you interested in contributing this functionality to CDT?

That would be a new experience for me. As I am on vacation for the next few weeks, I will return to this topic in August. This would give others the chance to comment on the solution.