Bug 180141 - Content Assist: no support for Doxygen & Co
Summary: Content Assist: no support for Doxygen & Co
Status: NEW
Alias: None
Product: CDT
Classification: Tools
Component: cdt-editor (show other bugs)
Version: 4.0   Edit
Hardware: All All
: P3 enhancement with 22 votes (vote)
Target Milestone: ---   Edit
Assignee: Project Inbox CLA
QA Contact: Jonah Graham CLA
URL:
Whiteboard:
Keywords: helpwanted
: 330301 (view as bug list)
Depends on:
Blocks:
 
Reported: 2007-03-30 03:45 EDT by Jens Elmenthaler CLA
Modified: 2020-09-04 15:20 EDT (History)
18 users (show)

See Also:


Attachments
Content assist with javadoc on the side (87.19 KB, image/png)
2015-03-31 10:59 EDT, Marc-André Laperle CLA
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Jens Elmenthaler CLA 2007-03-30 03:45:09 EDT
Build ID: 3.3M5

Steps To Reproduce:
1.
2.
3.


More information:
The code assist of the JDT shows the documentation of an element in the code assist window.
Having something like this for C++ and Doxygen saves quite a lot of work of location the documentation.
Comment 1 Jens Elmenthaler CLA 2007-11-23 16:11:37 EST
A very simple approach that came to my mind: just show the comments of the proposed elements.

This would help already quite a lot, but would possibly require much less work.

Comment 2 felix schmutz CLA 2008-07-16 08:46:51 EDT
the comment from Jens Elmenthaler is like he already states, only a workaround.

i also think being able to add documentation that would be shown in the content assist would great just like it is being done with Java or in Visual Studio. 
Even more now with the better integration of doxygen to CDT 5.0. 

Additionally this once already was implemented to some point wasnt it?
please take a look at 
http://www.eclipsecon.org/2004/EclipseCon_2004_TechnicalTrackPresentations/eclipsecon_marineau_cdt_presentation.pdf
where one can see content assist.

I am a bit disappointed at the lack of documentation if and how it it is possible to add documentation to Eclipse (CDT?). 

If in Eclipse you go to 
Window > Preferences > Help > Content

this looks like a point where external help can be put inside, but i did not find any documentation how this can be used or if it is working. 


So if this is possible to set up, users would need a document explaining how to set it up. If not, I also think it should be implemented.


NOTE: i think this is closely related to Bug 176925
Comment 3 Sergey Prigogin CLA 2010-11-15 19:52:31 EST
*** Bug 330301 has been marked as a duplicate of this bug. ***
Comment 4 Christoph Kulla CLA 2013-04-17 07:22:35 EDT
I just came across this limitation of the CDT. Was there any progress on this issue till 2007?
Comment 5 Anton Leherbauer CLA 2013-04-19 06:53:36 EDT
*** Bug 251050 has been marked as a duplicate of this bug. ***
Comment 6 Nathan Ridge CLA 2015-03-31 04:27:15 EDT
I'm a bit confused about what's being asked here:

  - The title of this bug talks about content assist.
    I tested content assist in JDT, invoking it and
    selecting a proposal, and at no point did I see
    documentation.

    So I'm confused about what JDT functionality is
    being asked for here. Could someone give a more
    detailed description, or a screenshot?

  - Bug 251050, which was marked as a duplicate, talks
    about hovers, which is a different thing from 
    content assist. I checked the behaviour of hovers
    in CDT for a call to a function which has Doxygen
    documentation, and I see we already show the Doxygen
    comment in the hover.

    If something more is being asked for w.r.t. hovers,
    could someone clarify what?

Thanks, and sorry if I'm being dense.
Comment 7 Marc-André Laperle CLA 2015-03-31 10:59:55 EDT
Created attachment 252043 [details]
Content assist with javadoc on the side

(In reply to Nathan Ridge from comment #6)
> I'm a bit confused about what's being asked here:
>     So I'm confused about what JDT functionality is
>     being asked for here. Could someone give a more
>     detailed description, or a screenshot?

I attached a screenshot of the javadoc in content assist. I think this is what this bug is asking for. Also, in a hover, it could display something similar (html-like display). That could be the default hover when not debugging. In JDT you have to hold shift to get the source hover.
Comment 8 Nathan Ridge CLA 2015-03-31 15:38:26 EDT
(In reply to Marc-Andre Laperle from comment #7)
> Created attachment 252043 [details]
> Content assist with javadoc on the side
> 
> (In reply to Nathan Ridge from comment #6)
> > I'm a bit confused about what's being asked here:
> >     So I'm confused about what JDT functionality is
> >     being asked for here. Could someone give a more
> >     detailed description, or a screenshot?
> 
> I attached a screenshot of the javadoc in content assist. I think this is
> what this bug is asking for. Also, in a hover, it could display something
> similar (html-like display). That could be the default hover when not
> debugging. In JDT you have to hold shift to get the source hover.

Thanks! (The reason I wasn't seeing this is because the documentation window overflowed past the edge of my screen, heh.)