A doxygen eclipse plugIn automatically generating stub documentation?

Question

I'am looking for an eclipse-plugin for doxygen code documentation. I have found the eclox-plugIn ( http://home.gna.org/eclox/ ). I would like find out, how can it automatically generate a "empty" doxygen comment, which could be filled out later or what is the better choice for a documentation eclipse plugIn?

For example for a function: void f(int p1, int p2, ...), it should generate:

/*! \brief ...
    \param p1 ...
    ..
*/

PS I'm using for mainly the c/c++ languages

score 93 · Answer 1 · edited May 20 '16 at 14:25

93

A different (better) approach than my previous answer:
In Window->Preferences->C/C++->Editor,
In the right tab look for "Documentation tool comments", and in "Workspace default" set doxygen.

Now you can type /** above a function and press return.

/**
int foo(int bar);

becomes

/**
 * 
 * @param bar
 * @return
 */
int foo(int bar);

edited May 20 '16 at 14:25

Antonio

19,451
13
99
197

answered Sep 28 '11 at 21:46

tauran

7,986
6
41
48

Exactly the switch I was looking for as well. Cheers. – Alchete Mar 24 '14 at 21:33
2

Not sure why this obvious thing not working in Eclipse Neon ? – Khulja Sim Sim Jul 12 '16 at 06:08
1

This should be top answer. – prasad Feb 09 '18 at 15:52
Great thank you, this should be the accepted answer! – ndarkness Feb 24 '21 at 13:25

score 23 · Accepted Answer · edited Mar 23 '18 at 17:50

23

See updated solution.

Old answer:
In eclipse helios in window->preferences you can do: c/c++->Code Style->Code Templates->Comments + Automatically add comments for new methods and classes

You can configure the comment style here, but it is not as smart as it should be. If you find something better, I would be very happy...

edited Mar 23 '18 at 17:50

ΦXocę 웃 Пepeúpa ツ

47,427
17
69
97

answered Sep 10 '10 at 08:20

tauran

7,986
6
41
48

Hi , I tried that , but does not seem to genrate the comment ... is there something i am missing .. – HelloWorld_Always Sep 27 '11 at 23:31
It's only for generated code... See my new answer. – tauran Sep 28 '11 at 21:42
For anyone who come looking for how to integrate eclox in eclipse, see https://github.com/theolind/mahm3lib/wiki/Integrating-Doxygen-with-Eclipse – shaffooo Oct 19 '16 at 18:28
1

Can Doxagen plugin be customized? For example, I'd like it to generate `@brief` keyword when adding function comment. – Danijel Feb 17 '17 at 13:26

score 7 · Answer 3 · edited May 23 '17 at 11:55

7

For Project specific settings
In Project->Properties->C/C++ General:

Tick Enable project specific Settings
Select Doxygen as Documentation tool

Then typing /** above the function/method and hitting enter will work. See here.

edited May 23 '17 at 11:55

Community

1
1

answered May 20 '16 at 14:20

Antonio

19,451
13
99
197

A doxygen eclipse plugIn automatically generating stub documentation?

3 Answers3

Linked