[Javadoc] -d 옵션

-d 옵션

-d 옵션은 생성 된 문서의 대상 디렉토리를 지정한다. 디렉토리는 상대 경로 또는 절대 경로로 지정한다.

사용법은 다음과 같다.

$ javadoc -d {출력하는 디렉토리 혹은 대상 파일}

예를 들면 다음과 같이 실행한다.

$ javadoc -d doc Sample.java
$ javadoc -d sample/doc Sample.java
$ javadoc -d /Users/devkuma/javadoc/doc Sample.java

1번째와 2번째는 상대 경로로 지정하였다. 1번째는 "javadoc"명령을 실행한 디렉토리에 "doc"디렉토리를 만들고 그 안에 저장한다. 2번째는 "sample\doc"이란 디렉토리를 만들고 그 안에 저장한다. 3번째는 절대 경로로 지정한다. "/Users/devkuma/javadoc/doc"이란 디렉토리에 저장한다.

실습

간단한 예를 실습해 보도록 하겠다.

/**
 * Javadoc 테스트용 클래스
 * 여러 줄로 작성할 수 있다.
 */
public class Sample02 {

    /**
     * 사이즈 설정
     *
     * @param width 폭
     * @param height 높이
     */
    public void setSize(int width, int height) {

    }
}

위에 소스 코드를 "Sample02.java"라는 파일명으로 저장하고 저장된 디렉토리에서 다음과 같이 실행한다.

$ javadoc -d doc/html Sample02.java

실행 결과는 아래와 같다.

$ javadoc -d doc/html Sample02.java
Loading source file Sample02.java...
Constructing Javadoc information...
Creating destination directory: "doc/html/"
Standard Doclet version 1.8.0_161
Building tree for all the packages and classes...
Generating doc/html/Sample02.html...
Generating doc/html/package-frame.html...
Generating doc/html/package-summary.html...
Generating doc/html/package-tree.html...
Generating doc/html/constant-values.html...
Building index for all the packages and classes...
Generating doc/html/overview-tree.html...
Generating doc/html/index-all.html...
Generating doc/html/deprecated-list.html...
Building index for all classes...
Generating doc/html/allclasses-frame.html...
Generating doc/html/allclasses-noframe.html...
Generating doc/html/index.html...
Generating doc/html/help-doc.html...

다음과 같이 javadoc를 실행한 디렉토리에 "doc/html"이란 디렉토리를 만들고, 그 안에 생성된 HTML 파일을 저장한다.

$ ls -al doc/html/
total 176
drwxr-xr-x  17 kimkc  staff    578 10 14 00:24 .
drwxr-xr-x  33 kimkc  staff   1122 10 14 00:24 ..
-rw-r--r--   1 kimkc  staff   8256 10 14 00:24 Sample02.html
-rw-r--r--   1 kimkc  staff    633 10 14 00:24 allclasses-frame.html
-rw-r--r--   1 kimkc  staff    613 10 14 00:24 allclasses-noframe.html
-rw-r--r--   1 kimkc  staff   3507 10 14 00:24 constant-values.html
-rw-r--r--   1 kimkc  staff   3457 10 14 00:24 deprecated-list.html
-rw-r--r--   1 kimkc  staff   7892 10 14 00:24 help-doc.html
-rw-r--r--   1 kimkc  staff   4190 10 14 00:24 index-all.html
-rw-r--r--   1 kimkc  staff   2744 10 14 00:24 index.html
-rw-r--r--   1 kimkc  staff   3684 10 14 00:24 overview-tree.html
-rw-r--r--   1 kimkc  staff    740 10 14 00:24 package-frame.html
-rw-r--r--   1 kimkc  staff      1 10 14 00:24 package-list
-rw-r--r--   1 kimkc  staff   3943 10 14 00:24 package-summary.html
-rw-r--r--   1 kimkc  staff   3693 10 14 00:24 package-tree.html
-rw-r--r--   1 kimkc  staff    827 10 14 00:24 script.js
-rw-r--r--   1 kimkc  staff  12842 10 14 00:24 stylesheet.css