fra3il

Doxygen

Introduction

fra3il

fra3il


LATEST POSTS

AWS Lambda 는 개뿔.. 하나도 모르겠다고! 03rd June, 2016

앱 아이콘에 앱 버전, 빌드 번호 등의 정보를 표시하는 방법 05th February, 2016

iOS

Doxygen

Posted on .

프로젝트 완료 이후에 문서 작업을 해야되는 상황에서 벗어나기 위해서 Doxygen 을 사용해보기로 했다.

1. 환경 설정
Wizard, Expert 탭에서 옵션을 조정할 수 있으며, 디폴트에서 변경된 옵션은 빨간색으로 표시된다.
현재 환경에서 빨간색으로 표시된 옵션은 아래와 같다.

  • Project – PROJECT_NAME
  • Project – PROJECT_NUMBER
  • Project – OUTPUT_DIRECTORY
  • Project – JAVADOC_AUTOBRIEEF ( O )
  • Build – EXTRACT_ALL ( O )
  • Build – EXTRACT_PRIVATE ( O )
  • Build – EXTRACT_STATIC ( O )
  • Build – EXTRACT_LOCAL_METHODS ( O )
  • Build – EXTRACT_ANON_NSPACES ( O )
  • HTML – GENERATE_DOCSET ( O )
  • HTML – GENERATE_TREEVIEW ( O )
  • HTML – SEARCHENGINE ( X )
  • LaTex – GENERATE_LATEX ( X )

옵션을 설정한 이후에 Settings – Use current settings at startup 을 잊지 말자.

2. 실행
Run – Run doxygen 으로 문서를 생성할 수 있으며, Show HTML output 으로 HTML 타입으로 생성된 문서를 볼 수 있다.

3. Main Page 작성

4. 주석

5. 기타
Xcode 의 User Code Snippet Library 기능을 활용하는 것을 권장한다.

@see 에 다른 클래스의 메소드, 인자가 여러개인 메소드를 연결하고 싶을 때는 아래와 같이 적는다.

관련 링크

fra3il

fra3il

Navigation