doxygen

3월 21일 첨기연 강의 이후 몇가지 Tip을 적어본다.

 

1. @since, @version

@version: 일종의 baseline성격을 가진다.

ex) file version 0.1, software version 0.3

@since: 언제 이후로 유효한지를 가리킨다.

ex) @since version 0.1

 

2. @enum, @struct와 같은 구조화 명령어에 name tag(ex, @enum, @struct... )를 붙이지 않아도 바로 아래 구조화 명령어를 인식한다.

ex)

/**

 * @enum doxyEnum

 * @brief This is for test

 */

enum doxyEnum { doxy_one, doxy_two };

과

/**

 * @brief This is for test

 */

enum doxyEnum {doxy_one, doxy_two };

는 같은 효과를 가진다. 단, 전자의 경우에는 임의 장소에 위치하여도 tag name을 보고 해당 구조화 명령어를 찾을 수 있다.

 

3. @brief 에는 여러 줄로 표기할 수 있다.

ex)

/**

 * @brief first sentence @n

 *          second sentence

 */

 

4. doxyfile은 renaming할 것을 권고한다. doxygen -g에 의해서 생성된 default name인 doxyfile은 실수로 doxygen -g를 다시하면 덮어쓰게 되어 삭제될 소지가 있다.

 

5. C, C++외 다른 언어에도 적용할 수 있다. 그러나 python과 같은 경우에는 주석의 시작을 /** 가 아닌 /## 과 같이 lang.의 주석 format을 따르게 된다.

 

6. 기본적으로 mainpage에는 @mainpage에서 지정한 이름이 나타나지만 이를 지정하지 않으면 doxyfile의 PROJECT_NAME에서 지정한 이름이 나타난다.

 

7. STRIP_CODE_COMMENTS 는 source file을 browse할 때 comment를 나타낼지 여부를 가리킨다.

 

8. doxyfile에서 path를 지정시에는 공백이 있을 경우를 대비하여 "로 시작하여 끝낼 것을 권고한다.

 

9. 문제가 발생하였을 경우에는 생성된 html/, late/ 폴더를 삭제하고 다시 수행할 것을 권한다.

 

10. chm의 한글이 깨졌을 경우에는 일단 OUTPUT_LANGUAGE 를 English로 설정하고 수행을 해 보도록 한다. 물론 9번을 적용해야 한다.

 

11. DOT_IMAGE_FORMAT은 기본적으로 png로 설정되어 있다. image가 나타나지 않을 경우에는 png로 설정하고 확인을 해 보도록 한다. 9번 적용을 잊지 않아야할 것이다.