기본적인 doxygen 이용 방법은 kldp를 참조하는 게 좋을 것이다. http://wiki.kldp.org/wiki.php/Doxygen 이 문서도 그 문서를 참고로 만들어졌다.
파이썬 주석을 doxygen 에서 인식할 수 있게 하려면 다음과 같이 한다. 다음은 doxygen 설명서에 나오는 예제이다.
==========================================
"""@package docstring
Documentation for this module.
More details.
"""
def func():
"""Documentation for a function.
More details.
"""
pass
class PyClass:
"""Documentation for a class.
More details.
"""
def __init__(self):
"""The constructor."""
self._memVar = 0;
def PyMethod(self):
"""Documentation for a method."""
pass
===============================================
잘 보일지는 모르겠지만 파이썬 주석으로 사용되는 연속된 3개의 큰따옴표(""")주석을 이용했다. 다른 언어와 달리 이름 밑에 주석만 달아놓으면 끝이다. 그리고 내가 자주 사용하는 방법은 다음이다. 같은 작용을 하지만 다른 주석을 이용했다.
=================================================
## @package pyexample
# Documentation for this module.
#
# More details.
## Documentation for a function.
#
# More details.
def func():
pass
## Documentation for a class.
#
# More details.
class PyClass:
## The constructor.
def __init__(self):
self._memVar = 0;
## Documentation for a method.
# @param self The object pointer.
def PyMethod(self):
pass
## A class variable.
classVar = 0;
## @var _memVar
# a member variable
===========================================
쉽게 이해 할 수 있으리라 생각된다. 기본적으로 시작을 ## 을 이용하되 연속된 주석은 샵 하나(#)만 이용핸서 나타냈다. 위의 것과 다른점이 있다면 주석이 붙는 위치이다. doxygen에 주석이 드러나지 않게 하려면 # 하나만 사용하면 된다.
다음으로 man 파일을 생성해 보겠다.
다시 말하지만 kldp 문서를 잘 참고하기 바란다. python 이므로 Wizard - Mode 에서 꼭 OPTMIZE OUTPUT JAVAt을 선택해야 한다. (메뉴얼이 이렇게 나와있다. )
그 이외는 별다른 특이 사항은 없다. 다만 파이썬의 경우 파일 자체를 utf-8로 되어 있는 경우가 있다. 이 경우 생성된 html 문서가 깨져보일 수 있다. 인코딩을 utf-8로 바꾸어서 보면 상관 없지만 조금 불편하다. 그래서 head 자체를 바꾸는 옵션을 사용하면 편리하다.
다음과 같은 내용을 같은 header.html 파일을 만든다.
=====================================================================
<meta http-equiv="Content-Type" content="text/html;charset=utf-8">
<title>DBS: Data Structures</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
=====================================================================
다음에 Doxygen에서 Step1 -> Expert 버튼을 클릭한다.
새로운 대화창에서 HTML 탭을 선택한 후 HTML_HEADER 에 위에서 만들었던 header.html 파일의 경로를 적어준다.
그리고 다시 문서를 생성하면 된다.
파이썬 주석을 doxygen 에서 인식할 수 있게 하려면 다음과 같이 한다. 다음은 doxygen 설명서에 나오는 예제이다.
==========================================
"""@package docstring
Documentation for this module.
More details.
"""
def func():
"""Documentation for a function.
More details.
"""
pass
class PyClass:
"""Documentation for a class.
More details.
"""
def __init__(self):
"""The constructor."""
self._memVar = 0;
def PyMethod(self):
"""Documentation for a method."""
pass
===============================================
잘 보일지는 모르겠지만 파이썬 주석으로 사용되는 연속된 3개의 큰따옴표(""")주석을 이용했다. 다른 언어와 달리 이름 밑에 주석만 달아놓으면 끝이다. 그리고 내가 자주 사용하는 방법은 다음이다. 같은 작용을 하지만 다른 주석을 이용했다.
=================================================
## @package pyexample
# Documentation for this module.
#
# More details.
## Documentation for a function.
#
# More details.
def func():
pass
## Documentation for a class.
#
# More details.
class PyClass:
## The constructor.
def __init__(self):
self._memVar = 0;
## Documentation for a method.
# @param self The object pointer.
def PyMethod(self):
pass
## A class variable.
classVar = 0;
## @var _memVar
# a member variable
===========================================
쉽게 이해 할 수 있으리라 생각된다. 기본적으로 시작을 ## 을 이용하되 연속된 주석은 샵 하나(#)만 이용핸서 나타냈다. 위의 것과 다른점이 있다면 주석이 붙는 위치이다. doxygen에 주석이 드러나지 않게 하려면 # 하나만 사용하면 된다.
다음으로 man 파일을 생성해 보겠다.
다시 말하지만 kldp 문서를 잘 참고하기 바란다. python 이므로 Wizard - Mode 에서 꼭 OPTMIZE OUTPUT JAVAt을 선택해야 한다. (메뉴얼이 이렇게 나와있다. )
그 이외는 별다른 특이 사항은 없다. 다만 파이썬의 경우 파일 자체를 utf-8로 되어 있는 경우가 있다. 이 경우 생성된 html 문서가 깨져보일 수 있다. 인코딩을 utf-8로 바꾸어서 보면 상관 없지만 조금 불편하다. 그래서 head 자체를 바꾸는 옵션을 사용하면 편리하다.
다음과 같은 내용을 같은 header.html 파일을 만든다.
=====================================================================
<meta http-equiv="Content-Type" content="text/html;charset=utf-8">
<title>DBS: Data Structures</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
=====================================================================
다음에 Doxygen에서 Step1 -> Expert 버튼을 클릭한다.
새로운 대화창에서 HTML 탭을 선택한 후 HTML_HEADER 에 위에서 만들었던 header.html 파일의 경로를 적어준다.
그리고 다시 문서를 생성하면 된다.