Doxygen, C/C++외의 코드 문서화 도구

POSTED AT 2010/09/27 19:54 | POSTED IN PROGRAM
크리에이티브 커먼즈 라이선스
Creative Commons License
  Doxygen은 주어진 소스 코드를 분석하고 소스 코드에 있는 특정한 형식의 주석을 이용해서 소스 코드를 자동으로 문서화해주는 프로그램이다. 결과는 일련의 HTML 페이지들이구, LATEX나 PDF 문서들을 만들어낼 수도 있다.
 일단 Doxygen을 설치 하기 전에 아래와 같이 해당 문서에그래프 다이어그램도 만들기 위해서는 Graphviz의 Graph Visualization Software를 설치할 필요가 있다. 


이 사이트에 접을 하면 위와 같이 첫 화면에서 current stable release 부분에서 다운을 받을 수 있다.
 graphviz-2.26.3.msi 이라는 파일 이름으로 다운이 받아졌을 것이다. 다운 받고 아무 폴더에 깔아 주기만 하면 된다.

 Doxygen 설치 
이제 본격적으로 Doxygen을 설치해보자. 


위에서 보이듯이 Download 메뉴를 클릭하고 중간쯤에 다운 받을 수 있는 화면이 나온다 윈도우에서는 Doxygen Wizard로 문서화를 간편하게 할 수 있다. Wizard가 나오기 전에는 조금 사용하기 불편했던 모양이지만, 요즘에는 편의성이 많이 제공되고 있다. 
다운을 받았으면 원하는 폴더에 설치를 해주자. 본인은 \Tools\Doxygen 1.7.1 이라는 폴더에 설치를 했다. 

 Doxygen Wizard 
 설치를 끝마쳤다면, bin 폴더에 doxywizard.exe 파일을 실행 시켜 보자. 

아래는 실행 시킨 모습이다. 실행을 시켰으니 옵션들에 대해서 알아 보자. 우선 Wizard - Project 부분이다.
 - 1번 : 프로젝트 이름을 설정한다. 
 - 2번 : 소스 파일이 있는 디렉토리를 설정한다. 
 - 3번 : 문서화한 결과 html들을 넣을 Destination Directory를 설정한다. 

- 1번 : Include cross-refeenced source code in the output 옵션은 각 함수마다 사용한 함수 코드로 바로 Jump할 수 있는 링크를 생성해 준다. 즉, html 문서에서 링크를 타고 넘나 드는 것과 같은 효과를 나타낸다.
 - 2번 : Doxygen에서는 각 코드만의 고유 주석 스타일을 가지고 있는데, 이런 주석 스타일에 맞춰서 해당 언어에 맞는 것에 체크를 해주면 된다. 

 - 이곳은 자신이 출력하고자 하는 형식을 고르는 곳이다. 

 - Wizard의 마지막 부분인 Diagrams 부분은 다이어그램을 사용할 것인지 안할 것인지 설정하는 부분이다. GraphViz를 설치 했다면 이 다이어그램을 사용할 수 있다.

 - 이런 설정을 다 마쳤다면 Run Doxygen을 통해 문서화하고 결과물들을 뽑아 낼 수 있다.

 Doxygen 에서 한글은? 
 간혹 가다가 문서화 했을 시, 주석에 한글사용을 했다면 깨지는 경우가 있다. 아까 expert부분을 넘어 갔는데, 이 부분은 세세한 설정부분이 있어 까다롭지만, 다른 것은 몰라도 이 한글이 안깨지게 하는 법만 알면 된다. 아래 빨간색 네모친 부분만 바꿔주자.

 Doxygen, chm 파일 만들기 
 PDF와 같이 manual이나 그런곳에 자주 보이는 chm 형식으로 파일을 만들 수 있다. Wizard - Output 부분에 chm 부분을 체크 하면 된다. 허나 이 설정을 체크만 한다고 해서 다 끝나는 것은 아니다. MS HTML Help가 필요하기 때문이다. 만약 깔려 있다면 상관없지만, 안깔려 있다면 꼭 설치를 해주고 설정을 해줘야 한다. 

위의 다운로드 링크를 클릭해 다운받고, 어디에다가 설치 했는지 알아 두자 Doxygen Wizard의 설정도 바꿔줘야 하기 때문이다.

Expert - HTML 부분에서 중간쯤에 GENERATE_HTMLHELP 부분을 체크 한 후, HHC_LOCATION 부분에서 아까 설치한 HTML Help의 프로그램 경로를 지정해 준다.


http://www.stack.nl/~dimitri/doxygen/index.html


Doxygenlatest release v1.8.2 - last page update Sat Aug 11 2012
Doxygen Manual

Generate documentation from source code

Doxygen is a documentation system for C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors), Fortran, VHDL, PHP, C#, and to some extent D.

It can help you in three ways:

  1. It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in $\mbox{\LaTeX}$) from a set of documented source files. There is also support for generating output in RTF (MS-Word), PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code.
  2. You can configure doxygen to extract the code structure from undocumented source files. This is very useful to quickly find your way in large source distributions. You can also visualize the relations between the various elements by means of include dependency graphs, inheritance diagrams, and collaboration diagrams, which are all generated automatically.
  3. You can also use doxygen for creating normal documentation (as I did for this manual).

Doxygen is developed under Linux and Mac OS X, but is set-up to be highly portable. As a result, it runs on most other Unix flavors as well. Furthermore, executables for Windows are available.


Doxygen license

Copyright © 1997-2012 by Dimitri van Heesch.

Permission to use, copy, modify, and distribute this software and its documentation under the terms of the GNU General Public License is hereby granted. No representations are made about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty. See the GNU General Public License for more details.

Documents produced by doxygen are derivative works derived from the input used in their production; they are not affected by this license.

User examples

Doxygen supports a number of output formats where HTML is the most popular one. I've gathered some nice examples of real-life projects using doxygen.

These are part of a larger list of projects that use doxygen. If you know other projects, let me know and I'll add them.

Commercial Support

I'm currently investigating the possibilities of providing commercial support for doxygen. The forms of support I'm thinking of are:

  • implementing features,
  • fixing bugs,
  • providing priority help in answering questions.

To get a better understanding of the feasibility, please let me know if you have a need for this type (or another type) of doxygen related commercial support.

Future work

Although doxygen is successfully used by large number of companies and open source projects already, there is always room for improvement.

You can submit enhancement requests in the bug tracker. Make sure the severity of the bug report is set to "enhancement".

Acknowledgements

Thanks go to:

  •  Malte Zöckler and Roland Wunderling, authors of DOC++. The first version of doxygen borrowed some code of an old version of DOC++. Although I have rewritten practically all code since then, DOC++ has still given me a good start in writing doxygen.
  • All people at Qt Software, for creating a beautiful GUI Toolkit (which is very useful as a Windows/Unix platform abstraction layer :-)
  • My brother Frank for rendering the logos.
  • Harm van der Heijden for adding HTML help support.
  • Wouter Slegers of Your Creative Solutions for registering the www.doxygen.org domain.
  • Parker Waechter for adding the RTF output generator.
  • Joerg Baumann, for adding conditional documentation blocks, PDF links, and the configuration generator.
  • Tim Mensch for adding the todo command.
  • Christian Hammond for redesigning the web-site.
  • Ken Wong for providing the HTML tree view code.
  • Talin for adding support for C# style comments with XML markup.
  • Petr Prikryl for coordinating the internationalization support. All language maintainers for providing translations into many languages.
  • The band Porcupine Tree for providing hours of great music to listen to while coding.
  • Andrea Schulte for translating part of the web page to German.
  • Jan Milz for mirroring the tar ball.
  • Techfacts.de for their long time contribution and support.
  • many, many others for suggestions, patches and bug reports.
Follow doxygen on Twitter Doxygen on freshmeat Doxygen on SourceForge 
 

This page was last modified on 11 August 2012. 
(c) 1997-2012 Dimitri van Heesch, first release 27 oct 1997.



독시전 사용법


초기 사용법


JAVADOC_AUTOBRIEF 옵션을 YES

Doxgen 에 대한 개인적인 생각, 굳이 안써도 된다는 의견

과거버전이긴 하지만 Doxgen syntax 에 관한 얘기가 있다.


doxgen 에 대한 여러가지 설명들

소스인사이트에 doxgen 주석 comment 추가

doxgen 주석에 관한 format template



출처 : http://acidlikk.tistory.com/entry/Doxygen에서-GraphVizdot로-Diagram-그리기



Doxygen에서 GraphViz(dot)로 Diagram 그리기

Posted 2007/11/28 14:59 by acidlikk
1. GraphViz(dot)을 설치한다. http://www.graphviz.org 에서 무료로 받을 수 있다.

2. Doxygen Wizard의 Diagrams 탭에서 Use dot tool from the GraphViz package to generate 선택. 그 밑의 체크박스는 취향에 따라...

3. Expert의 Dot 탭에서 설정을 해 준다.

먼저, DOT_PATH에 GraphViz의 dot이 깔린 bin 폴더의 절대 경로를 써준다. 예를 들어,

DOT_PATH: C:\Program Files\Graphviz2.16\bin

그리고 HAVE_DOT을 체크해준다. 나머지 체크박스도 취향에 따라...





반응형
저작자표시 비영리 동일조건

'디자인패턴과방법론 > 개발방법론' 카테고리의 다른 글

LineReader TDD 동영상  (0) 2012.11.01
TDD 개발방법론  (0) 2012.11.01
단위테스트  (0) 2012.10.31

+ Recent posts

티스토리툴바