임베디드 프로그래밍  

         
전체 기타 | WinCE | Delphi | VisualC | ARM | Media | SE | 마리오네트 | Java | wdm | JTAG | 영상처리 | 인증 | 질문/답변 | H/W | 알고리즘 | Platform | .net | VB | PPC | Network | android | QT | WWW | Linux |
doxygen 사용 방법
하창호11-28 12:20 | HIT : 4,812
doxygen 사용 방법

▧ doxygen 형식
- @n 행변환
- @b 굵은 문자
- @e 이텔릭체
- @c 타이프라이터 글자체
- 여러줄 주석 다음의 형식을 사용
/**
*
*/
- 단문 주석 ///
- 라인 뒤 주석 ///< 또는 /**< */
- @mainpage 메인페이지에 대한 주석
- @image html 이미지 파일명
- # 숫자 리스트
- @dir 특정 디렉토리에 대한 문서화 내용임을 정의
- @file 파일명 관련 주석 타이틀 생성 (위치 상관없음)
- @class 클래스에 관한 주석 타이틀 생성 (위치 상관없음)
- @brief 여러줄 혹은 단문의 주석 타이틀 생성 (바로 뒤의 내용에 대한 주석임을 의미)
- @author 작성자
- @remark
- @code ~ @endcode 코드 예제
- @param[in] | [out] | [inout] value(형식) 설명
- @par 파라메터 설명시 제목 쓸 때
- @return 리턴값
- @see 참조 함수
- @namespace c++ 전용
- @version 버젼
- @interface 이터페이스이름 인터페이스임을 명기
- @enum 해당 요소가 enum 임을 명기
- @warning 경고 문단 삽입
- @exception 예외상황 명기
- 타이틀 설정시 대소문자 구분

▧ config 파일을 제너레이션
- doxygen -g 파일명

▧ doxygen 설정
- PROJECT_NAME 프로젝트명
- PROJECT_NUMBER 버전
- OUTPUT_LANGUAGE 언어 korean
- INPUT 에 Path
- FILE_PATTERNS 에 *.h *.cpp
- RECURSIVE 하위 디렉토리 까지 사용할 때 YES
- EXTRACT_ALL 커맨트 없는 부분까지 처리 하고자 할 때 YES
- SORT_MEMBERS_DOCS 멤버 주석 소팅 필요시 YES

▧ doxygen 사용법
- doxygen 파일명

▧ 그래픽 추가
- Graphviz 를 인스톨해서 사용
- http://www.graphviz.org/Download_windows.php
- config 부분의 DOT_PATH 에 Graphviz 의 bin 위치
- config 부분의 HAVE_DOT 에 YES
- config 부분의 IMAGE_PATH 에 출력문서에 포함할 이미지 위치

▧ 주의 사항
- 파일과 클래스, 매크로, 구조체, Enum 부분 @brief 반드시 삽입
- 함수에 있어서 @param, @return 반드시 삽입
하창호   2006/11/28 
- @internal 의 경우 내부 문서 작성시 사용 config 에서도 수정해 줘야함
- @return 에러코드 @exception 1 ~~ 할 때 에러
- @since 버젼 최초 생성된 버젼
- @dection 테그명 섹션명 하면 섹션명으로 표시
- -# @ref 테그명 하면 숫자나오고 테크명 나옴 목차처럼 사용 가능
- @def group 그룹명 하고 @ing 그룹명 하면 문서별로 그룹화 할 수 있음
 


22  SE :: Doxygen 에서 한글 깨지는 부분 해결 방법    하창호 2008·08·13 3069
21  SE :: 비주얼 스튜디오 팀 시스템    하창호 2007·09·11 3373
20  SE :: 일반적인 개발 절차    하창호 2007·01·10 3367
19  SE :: ATAM 이란    하창호 2006·12·15 4396
18  SE :: Software Platform Architecture Desi...    하창호 2006·12·14 4210
17  SE :: C 의 Legacy Code 분석    하창호 2006·12·14 3738
16  SE :: C++ 의 Legacy Code 분석    하창호 2006·12·12 4198
15  SE :: Static Attribute 와 Operation UML 처...    하창호 2006·12·06 3390
14  SE :: Class Diagram 설명    하창호 2006·12·05 3585
13  SE :: Carnegie Mellon TSP Symposium 2007 ...    하창호 2006·12·01 3917
 SE :: doxygen 사용 방법  …1  하창호 2006·11·28 4812
11  SE :: ClearCase Document    하창호 2006·08·25 3668
10  SE :: Extreme Programming 강좌    하창호 2006·06·12 4048
9  SE :: Together 를 이용한 UI Designer 사용한 코...    하창호 2004·08·30 3757
8  SE :: 자바 소스의 리버스엔지니어링 결과 시퀀스 다이어그램    하창호 2004·08·30 5638
7  SE :: Together Workshop Q/A 자료    하창호 2004·08·30 3546
6  SE :: Together Workshop 발표자료    하창호 2004·08·30 3587
5  SE :: Together Testing Framework 설명    하창호 2004·08·30 3574
4  SE :: UML 로즈를 기준으로 정리된 자료    하창호 2004·05·14 3491
3  SE :: [논문] 사용행태 분석에 의한 냉장고 사용편의성 개선    하창호 2004·04·01 3407
2  SE :: 비밀이야 이건    하창호 2004·04·01 6
1  SE :: [논문] 가전제품 화면 메뉴의 사용서에 관한 연구  …1  하창호 2004·04·01 3429
1
   
Copyright 1999-2018 Zeroboard / skin by GGAMBO
....