开发者

A doxygen eclipse plugIn automatically generating stub documentation? [closed]

Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.

We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.

Closed 4 years ago.

Improve this question

I'am looking for an eclipse-plugin for doxygen code documentation. I have found the eclox-plugIn ( http://home.gna.o开发者_运维问答rg/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


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);


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...


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.

0

上一篇:

下一篇:

精彩评论

暂无评论...
验证码 换一张
取 消

最新问答

问答排行榜