Alex Rivera | Logout

Can Eclipse hover tips display Doxygen comments from header file?

Asked 2011-06-23T15:10:40.190
33

I'm using Eclipse CDT to write C++ code. Having read several discussions here on StackOverflow about whether to place doxygen documentation in the header file or the implementation file, it seems the majority of developers favour putting doxygen comments in the header file (although it's by no means a consensus, of course). However, if I put doxygen comments in my header files, I can't get Eclipse to display those comments when I hover the mouse pointer over an instance of the commented method/member. Is there a way to get Eclipse to make use of my Doxygen documentation from my header files in Eclipse's hover tips?

I've set "Documentation tool comments Workspace default" to "Doxygen" in Preferences > C/C++ > Editor.

I'm using Eclipse 3.6.2 with CDT 7.0.2 on Ubuntu 11.04.

Edit
Report

1 Answer

2

Doxygen comments are displayed in Eclipse on hover when written in:

  • cpp file (or header) file before method source (not declaration)
  • header file before class declaration
answered 2011-07-13T11:25:26.420

Your Answer