Doxygen이란?

Doxygen은 소프트웨어 레퍼런스 문서 생성기.

즉, 프로젝트 문서화를 쉽게 할 수 있도록 도와주는 도구

주석을 달아주면, 그 주석과 프로그램 구조를 토대로 전체 프로그램의 문서를 만들어줌

 

Doxygen 주석 예시

/*
@file AppMain.c
@date 2022/03
@author powerdeng2@naver.com 
@version 1.0
@brief 메인 소스 파일
*/

 

Doxygen 함수 주석 예시

/**
@fn                 unsigned char ParaSave(stPD* pstPD, signed short wData, unsigned char Ch, unsigned char IsComReq)
@brief              파라미터 저장 및 체크 함수
@param pstPD        stPD 타입 구조체 포인터
@param wData        저장 요청 데이터
@param Ch           드라이버 인덱스
@param IsComReq     통신 드라이버에서의 호출 여부
@return                          ok(0), false(other)
*/

 

주의사항

• #if, #endif와 같은 전처리기는 소스코드에서 제거해야 한다.
• 소스코드에 Static 함수가 있다면 일반 함수로 변경해야 한다.
• 소스파일의 인코딩 방식을 UTF-8로 변경한다.

아래와 같이 HTML문서로 만들어줌