본문 바로가기

Tools/Eclipse

이클립스에서 doxygen 사용하기.




Eclipse에 Doxyzen Plugin 설치

Doxyzen Install

http://www.stack.nl/~dimitri/doxygen/ 에서 Doxyzen을 받아 인스톨한다.

Eclipse에서 Help > Install New Software > Add 버튼을 클릭

Name : doxyzen
Location : http://download.gna.org/eclox/update 추가 및 인스톨

Name : ecolx
Location : http://anb0s.github.io/eclox 추가 및 인스톨
  
ecolx 참고 : https://anb0s.github.io/eclox/

Project > Preferences > Doxyzen 에서 Add 버튼을 클릭하여 1.에서

설치된 Doxyzen directory / bin 까지 설정하여 추가.

Eclipse 프로젝트 밑에 {Project_Name}.doxyfile 생성 및 Doxyfile 설정

상단의 Doxyzen 아이콘을 클릭하여 프로젝트에

{Project_Name}.doxyfile을 생성한다.


 

다음 생성된 doxyfile을 더블클릭하여 설정을 변경한다.

우선 Add버튼으로 Src 디랙토리를 설정 후 scan recursive

또한 설정한다.

다음 output formats을 rtf으로 하고 Optimize results for를

java로 설정한다.

 

마지막으로 프로젝트에서 우클릭하여 @Build Document를 선택한다.

그러면 html, latex, rtf가 생성되어 있는 것을 볼 수 있다. 

=============================================================================
CDT에서 doxygen comment 사용하기.

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

===========================================================================

사용법은 아래와 같다.

새로운 프로젝트에서  doxyfile을 만들어야 한다.

File -> New -> Other ->Other -> Doxygen을 선택한 후에 원하는 project를 선택하면

아래와 같은 화면을 볼 수 있다.

원하는 language 와 적용할 파일들의 패스를 지정한 뒤에

이클리스 메뉴 상단의  '@' 을 클릭하면  파일이 만들어진다.

Usage

You can create new Doxygen projects (also called doxyfiles) using the creation wizard. Go to "File->New->Other->Other->Doxygen Configuration". Press next and set both file location and name. Then a empty doxyfile will be created at the specified location, the wizard automatically adds the ".Doxyfile" extension.

You should now see a file with a blue @-sign icon. This is your new doxyfile. Double-clicking on it will open the editor. You can now browse and edit the settings.

eclox_editor_basic

eclox_editor_advanced