Maven을 이용한 자바 API 문서 만들기

Maven 빌드에는 다양한 기능이 있습니다.

최근 Maven 빌드 기능에 대해 하나씩 확인을 하고 있고 

이 내용에 대해 하나씩 정리를 해볼 예정입니다~ 

일단 첫번째로 할 내용으로는 자신이 개발한 자바 소스코드 내용을 문서화해주는 플러그인 입니다.

일단 Maven 프로젝트 이므로 pom.xml 파일이 있을 것이구요 

이 pom.xml 파일에 의존 라이브러리 저장소, 다운로드, 빌드, 리포팅 등을 설정할 수 있습니다.

자바 문서를 만드려면 플러그인을 등록해야하는데요

pom.xml 내용을 보다보면

<bulid>

     ...

</bulid>

가 있습니다. 이 안에 플러그인을 추가시켜주면 됩니다 ^^

플러그인 내용으로는 아래와 같이 써주시면 되요~ (2015/07/07 기준으로 사용한 버전)

<plugin>     <groupId>org.apache.maven.plugins</groupId>     <artifactId>maven-javadoc-plugin</artifactId>     <version>2.9.1</version> </plugin>

이렇게 쓴 후 프로젝트를 오른쪽 클릭 > Run As > Maven build를 클릭하게 됩니다.

클릭하면, 아래와같이 Run Configurations 이 보여지게 되고 여기 내용에서 Goals: 이라는 설정 칸에 다음과 같이 작성을 합니다 "javadoc:javadoc"

그런 후 Run을 하게되면 maven 프로젝트의 target > site > apidocs 안에 웹페이지 형태로 자바문서가 만들어지게 됩니다 ^^

이걸 원하는 곳에 본사하여 index.html을 웹브라우저로 실행하게되면 자신이 만든 자바 프로젝트의 패키지, 클래스, 멤버 함수들을 문서로 확인할 수 있게 되겠습니다~