Page 1 of 1
How tto insert doxygen comments
Posted: Thu Sep 04, 2008 11:29 am
by hbr_in
Hi,
How to insert doxygen comments or how to invoke doxygen comments. using code generation/refactoring-.Insert Doxygen Comment.
I came to know few things
1. It automatically adds doxygen params section param looking at functions & its arguments
2. It worked for few func & not all. And for few functions, it works few times and not always.
Can u give some example code and steps to use insert doxygen comments feature.
TIA
Regards
Gururaja
Re: How tto insert doxygen comments
Posted: Thu Sep 04, 2008 12:07 pm
by eranif
To insert doxygen comment:
Place the caret on the function you want to insert comment
right click -> refactoring -> insert doxygen comment
Note: make sure that the file is saved before adding a comment, otherwise it might fail
In case it still fails:
right click on the file -> retag file
and try again.
It works for me 99% of the time, there are few rare cases which it fails, but I failed to identify the problem.
Eran
Re: How tto insert doxygen comments
Posted: Thu Sep 04, 2008 2:16 pm
by hbr_in
Should the file be a part of the project. Does CL support Inserting Doxygen Comments for any non-worspace/non-project files.
I couldnt insert for non-worspace/non-project files.
eranif wrote:To insert doxygen comment:
Place the caret on the function you want to insert comment
right click -> refactoring -> insert doxygen comment
caret means start of line. correct me if i am wrong
Can u give more info for below cases
Code: Select all
static int func1(void)
{
...
...
}
Code: Select all
static
int func1(void)
{
...
...
}
eranif wrote:
In case it still fails:
right click on the file -> retag file
Re-tag option only available for project/workspace
eranif wrote:
It works for me 99% of the time, there are few rare cases which it fails, but I failed to identify the problem.
Eran
its working for single file project & few in multi-file projects. not for all files. i am trying to find when its not happening
Regards
Gururaja
Re: How tto insert doxygen comments
Posted: Thu Sep 04, 2008 2:39 pm
by eranif
hbr_in wrote:caret means start of line. correct me if i am wrong
Caret is the term for the little blinking vertical line
from wikipedia:
The term caret is also sometimes used in graphical user interface terminology where it means a text insertion point indicator, frequently represented by a blinking vertical bar. In this context, it may be used interchangeably with the word cursor, although the latter term is often reserved for a mouse pointer.
hbr_in wrote:static int func1(void)
{
...
...
}
Place the caret at 'func1' and select 'Refactoring -> insert doxygen comment'
hbr_in wrote:Re-tag option only available for project/workspace
ReTag is also available for file, right click *in the editor* and select 'Re-Tag fie'
Eran