Eclipse 를 이용한 JavaDoc API 생성하기

우리는 JavaDoc.exe 를 이용해서 간단하게 Java API Documentation 을 생성할 수 있다. 하지만, 우리가 아주 잘 사용하고 있는 Eclipse 툴을 사용해서 보다 편하게 문서를 생성할 수 있는데, 이 글에서는 Eclipse 를 이용해서 문서를 생성해 보자.

우선, 간단한 문서를 작성하고, Project --> Generate Javadoc... 메뉴를 클릭한다.

각 부분에 필요한 옵션은 바로 전 글에서 다뤘기 때문에, 참고하길 바란다.

Generate Javadoc 창을 보면, 여러 필요한 옵션이 있다.
먼저 [javadoc command :] 는 javadoc.exe 파일이 있는 곳을 지정한다. 보통 Eclipse 에서 자동으로 경로를 설정해 주지만, 다른 버전의 JDK 를 사용할 경우 별도로 [configure...] 버튼을 클릭해서 bin 디렉토리를 지정해 주면 된다. 
[Select types for which Javadoc will be generated:] 는 Javadoc 문서를 생성할 프로젝트를 지정한다.
[Create Javadoc for members with visibility:]는 Javadoc 에서 나타낼 범위를 지정한다. 보통은 protected 까지 지정하게 된다.
[Use standard doclet]은 [Destrnation:] 경로에 출력될 문서의 경로를 지정한다. 보통 해당 프로젝트 하위의 doc 디렉토리에 생성하게 된다.
필요한 옵션을 다 넣었으면 [Next] 버튼을 클릭한다.

이 창에서는 [Document title:] 을 통해 문서의 제목을 지정할 수 있다.
또, [Basic Options],[Document these tags],[Select referenced archives and projects to which links should be generated:] 그리고 [Style sheet] 까지 선택할 수 있다. [Next] 버튼을 클릭하자.

이 창에서는, [Overview]와 [VM options] 을 통해 여러 옵션들을 지정할 수 있으며, 필요하다면 지금까지 설정된 내용을 Ant 스크립트로 내보낼 수 있다. 설정을 다한 다음, [Finish] 버튼을 클릭하자.

이제 끝났다. 해당 프로젝트 하위의 doc 디렉토리의 index.html 을 열어보면 위의 그림처럼 Java API 문서가 생성된 것을 확인할 수 있다.