Doxygen

From YYpBD's MediaWiki

소스 코드 문서화 툴

목차 1 Link 2 Tagging Example 2.1 구조적 지시자 2.2 섹션 지시자

Link

• Doxygen
• Graphviz
• DoxBar VC용 플러그인

Tagging Example

여기 예제는 Doxygen manual의 Special Commands의 예제이다.

구조적 지시자

• \file

파일명과 파일에 대한 설명을 기술한다.

/** \file file.h
 * A brief file description.
 * A more elaborated file description.
 */

• \class

클래스를 표시한다.

섹션 지시자

/*! \class WindowsNT
 *  \brief Windows Nice Try.
 *  \author Bill Gates
 *  \author Several species of small furry animals gathered together 
 *          in a cave and grooving with a pict.
 *  \version 4.0
 *  \date    1996-1998
 *  \bug It crashes a lot and requires huge amounts of memory.
 *  \bug The class introduces the more bugs, the longer it is used.
 *  \warning This class may explode in your face.
 *  \warning If you inherit anything from this class, you're doomed.
 */

• \author

작성자 이름

• \brief

설명

• \bug

버그 사항

• \date

작성 날짜

• \version

버전 표시

• \warning

경고

/*! \class Test
 * Normal text.
 *
 * \par User defined paragraph:
 * Contents of the paragraph.
 *
 * \par
 * New paragraph under the same heading.
 *
 * \note
 * This note consists of two paragraphs.
 * This is the first paragraph.
 *
 * \par
 * And this is the second paragraph.
 *
 * More normal text. 
 */
class Test {};

• \note

노트표시

• \par

문단표시

/*!
 Copies bytes from a source memory area to a destination memory area,
 where both areas may not overlap.
 @param[out] dest The memory area to copy to.
 @param[in]  src  The memory area to copy from.
 @param[in]  n    The number of bytes to copy
 @return          None
 @todo            Nothing
 */
void memcpy(void *dest, const void *src, size_t n);

• \param

파라미터를 표시한다.

in과 out으로 입력받을 인자, 데이터를 전달한 인자를 표시한다.

• \return

결과값

• \todo

추가 작업할 사항