패키지 태그는, 패키지의 다큐멘테이션 코멘트로 사용할 수 있는 태그입니다. 이 다큐멘테이션 코멘트는,package.html (이)라는 이름의 원시 파일내에 있습니다. 여기서 사용할 수 있는 @serial 태그는,include 또는 exclude 인수를 지정한 것 뿐입니다.
이하에, 클래스 또는 인터페이스의 다큐멘테이션 코멘트로 사용할 수 있는 태그를 나타냅니다. 여기서 사용할 수 있는 @serial 태그는,include 또는 exclude 인수를 지정한 것 뿐입니다.
이하에, 필드의 다큐멘테이션 코멘트로 사용할 수 있는 태그를 나타냅니다.
- -overview path/filename
- Javadoc 에 대해서,path/filename 그리고 지정된 「소스」파일로부터 개요 문서용의 텍스트를 취득해, 그 텍스트를 개요 페이지 (
overview-summary.html) 에 배치하도록(듯이) 지정합니다.path/filename 는,-sourcepath 에의 상대 패스입니다.filename 와 path 에는, 각각 임의의 이름과 장소를 지정할 수 있습니다만, 통상은,overview.html (이)라는 이름을 붙여, 소스 트리내의 최상정도의 패키지 디렉토리가 있는 디렉토리에 배치합니다. 이 장소에 배치하면(자),-sourcepath 에 의해 이 파일이 지시해지므로, 패키지를 문서화할 때에 path 가 불필요하게 됩니다. 예를 들어,java.lang 패키지의 소스 트리가 /src/classes/java/lang/ 의 경우, 개요 파일을 /src/classes/overview.html 에 배치할 수 있습니다. 「사용예」를 참조해 주세요.
path/filename 로 지정하는 파일에 대해서는,「개 요점 코멘트 파일」을 참조해 주세요.
개요 페이지가 작성되는 것은, Javadoc 에 복수의 패키지명을 건네주었을 경우만입니다. 자세한 것은,「HTML 프레임」을 참조해 주세요.
개요 페이지의 타이틀은,-doctitle 에 의해 설정됩니다.
- -public
- public 클래스 및 멤버만을 표시합니다.
- -protected
- protected 및 public 의 클래스와 멤버만을 표시합니다. 이것은 디폴트의 설정입니다.
- -package
- package, protected, 및 public 의 클래스와 멤버만을 표시합니다.
- -private
- 모든 클래스와 멤버를 표시합니다.
- -help
- on-line help를 표시합니다. Javadoc 와 도크 렛의 커멘드행 옵션이 일람표 나타납니다.
- -doclet class
- 문서의 생성에 사용하는 도크 렛을 기동하기 위한 클래스 파일을 지정합니다. 완전 지정의 이름을 지정해 주세요. 이 족크렉 트에 의해, 출력의 내용과 형식이 정의됩니다.
-doclet 옵션이 사용되지 않은 경우, Javadoc 는, 표준 도크 렛을 사용해 디폴트의 HTML 형식을 생성합니다. 이 클래스에는,start(Root) 메소드가 포함되지 않으면 안됩니다. 이 기동 클래스에의 패스는,-docletpath 옵션에 의해 정의됩니다.예를 들어, MIF 도크 렛을 호출하려면 , 다음과 같이 지정합니다.
-doclet com.sun.tools.doclets.mif.MIFDoclet
특정의 도크 렛을 실행한 완전한 예에 대해서는,「Running the MIF Doclet」를 참조해 주세요.
- -docletpath classpathlist
-doclet 옵션으로 지정되고 있는 도크 렛 개시 클래스 파일, 및 거기에 의존한다 jar 파일에의 패스를 지정합니다. 개시 클래스 파일이 jar 파일내에 있는 경우, 이하의 예의 같게 jar 파일의 패스가 지정됩니다. 절대 패스 또는 현재의 디렉토리로부터의 상대 패스를 지정할 수 있습니다. classpathlist 에는, 복수의 패스 또는 JAR 파일을 포함할 수가 있습니다. 그 경우, 각 패스 또는 JAR 파일을, Solaris 의 경우에는 구두점 (:), Windows 의 경우에는 세미콜론 (;) 그리고 단락짓습니다. 목적의 도크 렛 개시 클래스가 벌써 검색 패스내에 있는 경우는, 이 옵션은 불필요합니다.jar 파일에의 패스의 예에는, 도크 렛 개시 클래스 파일이 포함되어 있습니다. jar 파일명이 포함되어 있는 점에 주목해 주세요.
-docletpath /home/user/mifdoclet/lib/mifdoclet.jar
도크 렛 개시 클래스 파일의 패스의 예클래스 파일명이 생략 되고 있는 점에 주목해 주세요. -docletpath /home/user/mifdoclet/classes/com/sun/tools/doclets/mif/
특정의 도크 렛을 실행한 완전한 예에 대해서는,「Running the MIF Doclet」를 참조해 주세요.
- -1. 1
- 이 기능은, Javadoc 1.4 에서는 삭제되었습니다. 대체 기능은 없습니다. 이 옵션은, Javadoc 1.1 에 의해 생성되는 것과 같은 외관과 기능을 가지는 문서를 작성하기 위한의 것이었습니다. 상자의 클래스는 서포트되고 있지 않습니다. 이 옵션이 필요한 경우는, Javadoc 1.2 또는 1.3 을 사용해 주세요.
- -source release
- 받아들이는 원시 코드의 버젼을 지정합니다. release 에는 다음의 값을 지정할 수 있습니다.
| 1.5 |
Javadoc 는, JDK 1.5 로 도입된 범용 기능 및 다른 언어 기능을 포함한 코드를 받아들입니다. -source 플래그를 지정하지 않으면 컴파일러는 디폴트로서 1.5 의 동작을 합니다. |
| 1.4 |
Javadoc 는, JDK 1.4 로 도입된, assertion를 포함한 코드를 받아들입니다. |
| 1.3 |
Javadoc 는, JDK 1.3 이후에 도입된 assertion, 범용 기능, 또는 다른 언어 기능을 서포트하지 않습니다. |
javac 로 코드를 컴파일 할 경우에 사용한 값에 대응하는 release 의 값을 사용합니다.
- -sourcepath sourcepathlist
javadoc 커멘드에 패키지명 또는 -subpackages (을)를 건네줄 때, 원시 파일 (. java)를 검색하기 위한 패스를 지정합니다. sourcepathlist 에는, 구두점 (:)으로 단락지어 복수의 패스를 포함할 수가 있습니다. Javadoc 툴은, 지정된 패스 이하의 모든 서브 디렉토리를 검색합니다. 이 옵션을 사용해, 문서화 되는 원시 파일의 위치 뿐만이 아니라, 그 자체는 문서화 되지 않지만 문서화 되는 원시 파일로부터 상속된 코멘트를 가지는 원시 파일의 위치도 확인할 수 있습니다.-sourcepath 옵션은, javadoc 커멘드에 패키지명을 건네줄 때만 사용할 수 있습니다. javadoc 커멘드에게 건네진다 . java 파일은, 이 패스로부터는 검색되지 않습니다. . java 파일을 검색하려면 , 그 파일이 있는 디렉토리에 cd 에 의해 이동하는지, 또는 각 파일의 선두에 패스를 포함합니다 (「1 개이상의 클래스의 문서화」를 참조). -sourcepath 가 생략 되었을 경우, Javadoc (은)는, 클래스 패스를 사용해 원시 파일을 검색합니다 (-classpath (을)를 참조). 따라서, 디폴트의 -sourcepath 는, 클래스 패스의 값입니다. -classpath 도 생략 해 패키지명을 Javadoc 에 건네주면(자), Javadoc 는 현재의 디렉토리 및 그 서브 디렉토리로부터 원시 파일을 검색합니다.
sourcepathlist 에는, 문서화하는 패키지명의 소스 트리의 루트 디렉토리를 설정합니다. 예를 들어,com.mypackage (이)라는 이름의 패키지를 문서화하는 경우에, 그 원시 파일이 다음의 장소에 있다고 합니다.
/home/user/src/com/mypackage/*.java
이 경우, 다음과 같이 해 sourcepath 를 /home/user/src, 즉 com/mypackage 를 포함한 디렉토리로 지정해, 그리고 패키지명 com.mypackage (을)를 지정합니다. % javadoc -sourcepath /home/user/src/ com.mypackage
이 지정 방법은, 「소스 패스의 값과 패키지명을 연결해, 닷을 slash 「/」에 바꾸면(자), 패키지의 풀 패스 (/home/user/src/com/mypackage) (이)가 된다」라고 기억하면 간단합니다.2 개의 소스 패스를 설정하려면 , 다음과 같이 합니다.
% javadoc -sourcepath /home/user1/src:/home/user2/src com.mypackage
- -classpath classpathlist
- Javadoc 가참조 클래스 (
. class 파일)을 검색하는 패스를 지정합니다. 참조 클래스란, 문서화 되는 클래스와 그러한 클래스에 의해 참조되는 모든 클래스입니다. classpathlist 에는, 구두점 (:)으로 단락지어 복수의 패스를 포함할 수가 있습니다. Javadoc 툴은, 지정된 패스 이하의 모든 서브 디렉토리를 검색합니다. classpathlist 를 지정할 때는,클래스 패스의 문서에 있는 지시에 따라 주세요.-sourcepath 가 생략 되고 있는 경우, Javadoc 툴은,-classpath (을)를 사용해, 클래스 파일 뿐만이 아니라 원시 파일도 검색합니다 (하위 호환성이기 때문에). 따라서, 원시 파일과 클래스 파일을 다른 패스로부터 검색할 필요가 있는 경우는,-sourcepath (와)과 -classpath 의 양쪽 모두를 사용합니다.
예를 들어,com.mypackage 를 문서화하는 경우에, 원시 파일이 디렉토리 /home/user/src/com/mypackage에 있어, 이 패키지가 /home/user/lib 내의 라이브러리를 사용한다면, 다음과 같이 지정합니다.
% javadoc -classpath /home/user/lib -sourcepath /home/user/src com.mypackage
다른 툴과 같게,-classpath 가 지정되어 있지 않은 경우는, CLASSPATH 환경 변수가 설정되어 있으면, Javadoc 툴은 이 환경 변수를 사용합니다. 어느쪽이나 설정되어 있지 않은 경우, Javadoc 툴은 현재의 디렉토리에서 클래스를 검색합니다.확장 기능 클래스 및 bootstrap 클래스에 관련한, Javadoc 툴이 -classpath (을)를 사용해 유저 클래스를 검색하는 방법에 대한 자세한 것은,「클래스의 검색 방법」을 참조해 주세요.
- -subpackages package1:package2:...
- 원시 파일로부터 지정된 패키지 및 그 서브 패키지내에 재귀적으로 문서를 생성합니다. 이 옵션은, 소스코 드에 새로운 서브 패키지를 추가할 때에 편리합니다. 새로운 서브 패키지는 자동적으로 짜넣어집니다. 각 package 인수는, 임의의 최상정도 서브 패키지 (
java등) 또는 완전 지정의 패키지 (javax.swing 등)이 됩니다. 원시 파일을 포함할 필요는 없습니다. 인수는, 구두점으로 단락지어집니다 (모든 operating system). 와일드 카드는 불필요합니다 (사용 불가). 패키지의 검색 장소를 지정하려면 ,-sourcepath 를 사용합니다. 이 옵션은,「원시 파일의 처리」로 설명했던 대로, 소스 트리에 있지만 팍케이 지에는 속하지 않은 원시 파일을 처리하지 않기 때문에 도움이 됩니다.다음에 예를 나타냅니다.
% javadoc -d docs -sourcepath /home/user/src -subpackages java:javax.swing
이 커멘드는, 「java」 및 「javax.swing」라고 하는 이름의 패키지와 이러한 서브 패키지 전부의 문서를 생성합니다.-exclude 와 함께 -subpackages (을)를 사용하면(자), 특정의 패키지를 제외할 수 있습니다.
- -exclude packagename1:packagename2:...
- 지정된 패키지와 그 서브 패키지를
-subpackages 에 의해 작성된 리스트로부터 무조건 제외합니다. 과거의 -subpackages 옵션의 지정에 의해 짜넣어진 패키지, 또는 장래 짜넣어지는 패키지도 제외의 대상이 됩니다. 다음에 예를 나타냅니다. % javadoc -sourcepath /home/user/src -subpackages java -exclude java.net:java.lang
이 중,java.io,java.util,java.math (은)는 짜넣어집니다만,java.net 와 java.lang 이하의 패키지는 제외됩니다. 다만,java.lang 의 서브 패키지인 java.lang.ref (은)는 제외됩니다.
- -bootclasspath classpathlist
- 부트 클래스가 존재하는 패스를 지정합니다. 부트 클래스란, 통상, Java 플랫폼의 코어 클래스입니다. 부트 클래스 패스는, Javadoc 툴이 원시 파일과 클래스 파일을 찾을 때 사용하는 검색 패스의 일부입니다. 자세한 것은,「javac 와 javadoc 가 클래스를 검색하는 방법」을 참조해 주세요. classpathlist내의 복수의 디렉토리는, 구두점 (:)으로 단락짓습니다.
- -extdirs dirlist
- 확장 기능 클래스가 존재하는 디렉토리를 지정합니다. 확장 기능 클래스란, Java 확장 기능 기구를 사용하는 모든 클래스입니다. extdirs 는, Javadoc 툴이 원시 파일과 클래스 파일을 찾을 때 사용하는 검색 패스의 일부입니다. 자세한 것은, 전술의
-classpath (을)를 참조해 주세요. dirlist 내의 복수의 디렉토리는, 구두점 (:)으로 단락짓습니다.
- -verbose
- javadoc 의 실행중에 상세한 메세지를 표시합니다. verbose 옵션을 지정하지 않으면 원시 파일의 로드시, 문서의 생성시 (원시 파일 마다 1 개의 메세지), 및 소트시에 메세지가 표시됩니다. verbose 옵션을 지정하면(자), 각 Java 원시 파일의 해석에 필요로 한 시간 (밀리 세컨드 단위) 등, 추가의 메세지가 표시됩니다.
- -quiet
- 에러 메세지 또는 경고 메세지 이외의 메세지를 억제해, 경고와 에러만이 표시되도록(듯이) 해, 이것들을 특정하기 쉽고 섬 . 버젼 캐릭터 라인도 억제합니다.
- -breakiterator
- 영어 언어라고 하는 로케일 고유의 알고리즘은 아니고,
java.text.BreakIterator 의 국제화 된 문장 경계를 사용해, 영문의 최초의 문장의 마지막을 판단합니다 (다른 모든 로케일은 벌써 BreakIterator(을)를 사용). 「최초의 문장」이란, 패키지, 클래스, 또는 멤버의 주설명에서의 최초의 문장입니다. 이 문장은, 패키지, 클래스, 또는 멤버의 요약에 코 피 되어 알파벳순서의 인덱스에 카피됩니다.JDK 1.2 이후, BreakIterator 클래스는, 영어를 제외한 모든 언어의 문장의 마지막을 판단하기 위해서(때문에), 벌써 사용되고 있습니다. 따라서, 1.2 이후에서는,-breakiterator 옵션은 영문 이외에는 효과가 없습니다. 영문에는, 다음과 같은 독자적인 디폴트의 알고리즘이 있습니다.
- 영문의 디폴트의 문장 단락 알고리즘 - 공백 또는 HTML 블록 태그 (
<P> 등)이 계속되는 피리어드로 정지한다
- breakiterator 문 단락 알고리즘 - 일반적으로, 다음의 말이 대문자로 시작되는 경우, 공백 문자가 계속되는 피리어드, 물음표, 또는 감탄부로 정지한다. 이 알고리즘에서는, 대부분의 생략 표기가 처리된다 ( 「The serial no. is valid」는 처리되지만 「Mr. Smith」는 처리되지 않는다). HTML 태그나, 숫자 또는 기호로 시작되는 문장에서는 정지하지 않는다. HTML 태그에 파묻히고 있는 경우에서도, 「../filename」의 마지막 피리어드로 정지한다
주: 1.5. 0 으로부터는, 1.4.x 에 설치되고 있던 breakiterator 경고 메세지를 삭제해, 디폴트의 문장 단락 알고리즘을 변경하고 있습니다. 즉, -breakiterator 옵션은, 1.5. 0 그럼 디폴트는 아니게 되어, 또 디폴트로 할 생각도 없습니다. 이것은, 「다음의 메이저 릴리스」(1.5. 0) 그리고 디폴트를 변경한다고 하는, 이전의 목적과는 거꾸로 되고 있습니다. 즉, 원시 코드를 변경하지 않고, 1.4.x 에서의 breakiterator 경고를 제거하고 있지 않는 경우에서도, 1.5. 0 으로부터는 아무것도 할 필요가 없고, 경고는 소멸하고 있습니다. 이 반대 귀가의 이유는, breakiterator (을)를 디폴트로 하는 메리트보다, 디폴트로 하기 위해서(때문에) 필요한, 호환성이 없는 소스의 변경이 부담이 컸기 (위해)때문에입니다. 이것에 소비한 작업이나 혼란이 쓸데없게 되어 유감입니다.
- -locale language_country_variant
중요 - -locale 옵션은,표준 도크 렛이 제공하는 모든 옵션, 또는 그 외의 임의의 도크 렛의 제공하는 모든 오프 숀보다 전 (좌측) (으)로 지정할 필요가 있습니다. 그렇게 하지 않으면 네비게이션 바가 영어로 표시됩니다. 이 커멘드행 옵션만은, 지정하는 순서에 의존합니다.
Javadoc 가 문서를 생성할 경우에 사용하는 로케일을 지정합니다. 인수에는, java.util.Locale 의 문서로 설명되고 있는 로케일의 이름을 지정합니다. 예를 들어,en_US (영어, 미국),en_US_WIN (Windows 로 사용되는 영어) 등을 지정합니다.로케일을 지정하면(자), 지정한 로케일의 resource file가 Javadoc 에 의해 선택되어, 메세지 (네비게이션 바, 리스트와 겉(표)의 찾아내, 헬프 파일의 목차, stylesheet.css 의 코멘트등의 캐릭터 라인) (을)를 위해서(때문에) 사용됩니다. 또, 알파벳순서에 소트 되는 리스트의 소트순서, 및 최초의 문장의 말미를 판별하기 위한 문의 단락 문자도, 지정한 로케일 에 의해 정해집니다. 다만, 이 옵션은, 문서화 되는 클래스의 원시 파일내에서 지정되고 있는 다큐멘테이션 코멘트의 텍스트 의 로케일을 결정하는 것이 아닙니다.
- -encoding name
- 원시 파일의 인코딩의 이름 (
EUCJIS/SJIS 등) (을)를 지정합니다. 이 옵션이 지정되어 있지 않은 경우는, 플랫폼의 디폴트 컨버터가 사용됩니다.-docencoding 및 -charset 도 참조해 주세요.
- -Jflag
- javadoc 를 실행하는 실행시 시스템 java 에,flag (을)를 직접 건네줍니다.
J 와 flag 의 사이에 공백을 들어갈 수 있어 되지 않습니다. 예를 들어, 생성 문서를 처리하기 위해서 시스템으로 32M 바이트의 메모리를 확보해 둘 필요가 있는 경우는, Java 의 -Xmx 옵션을 다음과 같이 호출합니다. -Xms (은)는, 생략 가능합니다. 이것은, 초기 메모리의 사이즈를 설정할 뿐(만큼)의 옵션으로, 필요한 메모리의 최소 사이즈를 알 수 있고 있는 경우에 편리합니다. % javadoc -J-Xmx32m -J-Xms32m com.mypackage
사용하고 있는 javadoc 의 버젼을 확인하려면 , 다음과 같이 java 의 「-version」옵션을 불러 냅니다.
% javadoc -J-version
java version "1.2"
Classic VM (build JDK-1. 2-V, green threads, sunwjit)
출력 스트림에는표준 도크 렛의 버젼 번호가 포함됩니다.
- -d directory
- 생성된 HTML 파일을 보존하는 생성처 디렉토리를 지정합니다( 「d」는 「생성처 (destination)」의 의미). 이 옵션을 생략 하면(자), 생성된 파일은 현재의 디렉토리에 보존됩니다. 값 directory 에는, 절대 디렉토리, 또는 현재의 작업 디렉토리로부터의 상대 디렉토리를 지정할 수 있습니다. 버젼 1.4 에서는, javadoc (을)를 실행하면(자) 생성처 디렉토리가 자동적으로 작성됩니다.
예를 들어, 다음의 예에서는,com.mypackage 패키지의 문서를 생성해, 결과를 /home/user/doc/ 디렉토리에 보존합니다.
% javadoc -d /home/user/doc com.mypackage
- -use
- 문서화 되는 클래스 및 패키지 마다 1 개의 「사용」페이지를 짜넣습니다. 이 페이지에는, 그 특정의 클래스 또는 패키지의 API (을)를 사용하고 있는 패키지, 클래스, 메소드, constructor , 및 필드가 기술됩니다. 예를 들어, 클래스 C 를 예를 들면(자), 클래스 C (을)를 사용하고 있는 것으로서는, C 의 서브 클래스, C 로서 선언되고 있는 필드, C 를 돌려주는 메소드, 및, 형태 C 의 파라미터를 가지는 메소드와 constructor 이 있습니다.
예를 들어, String 의 「사용」페이지에 무엇이 표시될까를 봅시다. java.awt.Font 클래스의 getName()메소드는,String 형을 돌려줍니다. 따라서,getName() (은)는 String 를 사용하고 있으므로,String 의 「사용」페이지에는 이 메소드가 있습니다.
다만, 문서화 되는 것은 API 의 사용 뿐이어, 구현은 문서화 되지 않습니다. 어느 메소드가, 그 구현 중(안)에서 String 를 사용하고 있어도, 인수로서 캐릭터 라인을 취하거나 캐릭터 라인을 돌려주거나 하지 않는 경우는,String 의 「사용」이란 보여지지 않습니다.
생성된 「사용」페이지에 액세스 하려면 , 목적의 클래스 또는 패키지로 이동해, 네비게이션 바의 「사용」링크를 클릭 합니다.
- -version
- 생성 문서에, @version 의 텍스트를 짜넣습니다. 이 텍스트는, 디폴트에서는 생략 됩니다. 사용하고 있다 Javadoc 툴의 버젼을 확인하려면 ,
-J-version 옵션을 사용합니다.
- -author
- 생성 문서에, @author 의 텍스트를 짜넣습니다.
- -splitindex
- 색인 파일을 알파벳 마다 복수의 파일에 분할해, 문자 마다 1 개의 파일과 알파벳 이외의 문자로 시작되는 색인 엔트리용으로 1 개의 파일을 작성합니다.
- -windowtitle title
- HTML 의 <title> 태그에 배치하는 타이틀을 지정합니다. 지정한 타이틀은, 윈도우의 타이틀이나, 이 페이지에 대해서 작성된 브라우저의 북마크 (마음에 드는 것)에 표시됩니다. 이 타이틀에는 HTML 태그를 포함하지 말아 주세요. 타이틀에 HTML 태그가 포함되어 있으면(자), 브라우저가 태그를 올바르게 해석할 수 없습니다. title 중(안)에서 인용부호를 사용하는 경우는, 인용부호를 이스케이프 할 필요가 있습니다. -windowtitle 가 생략 되고 있는 경우, Javadoc 툴은, 이 옵션 대신에 -doctitle 의 값을 사용합니다.
% javadoc -windowtitle "Java 2 Platform" com.mypackage
- -doctitle title
- 개요 파일의 최상부의 근처에 배치하는 타이틀을 지정합니다. 타이틀은 centering가 되어, 레벨 1 의 표제로서 상부 네비게이션 바의 바로 아래에 놓여집니다. title 에는, HTML 태그와 공백을 포함할 수가 있습니다만, 이것들을 포함하는 경우는, 전체를 인용부호로 둘러싸지 않으면 안됩니다. title 중(안)에서 인용부호를 사용하는 경우는, 인용부호를 이스케이프 할 필요가 있습니다.
% javadoc -doctitle "Java<sup><font size=\"-2\">TM</font></sup>" com.mypackage
- -title title
- 이 옵션은, 현재는 존재하지 않습니다. Javadoc 1.2 의 베타판에만 존재했습니다. 이 옵션은,
-doctitle (이)라는 이름으로 변경되었습니다. 이름을 변경한 이유는, 이 옵션이, 윈도우의 타이틀은 아니고 문서의 타이틀을 정의하는 것을 명확하게 한다 유익입니다.
- -header header
- 각 출력 파일의 상단에 배치하는 헤더 텍스트를 지정합니다. 헤더는, 상부 네비게이션 바의 우측으로 배치됩니다. header 에는, HTML 태그와 공백을 포함할 수가 있습니다만, 이것들을 포함하는 경우는, 전체를 인용부호로 둘러싸지 않으면 안됩니다. header 중(안)에서 인용부호를 사용하는 경우는, 인용부호를 이스케이프 할 필요가 있습니다.
% javadoc -header "<b>Java 2 Platform </b><br>v1. 4" com.mypackage
- -footer footer
- 각 출력 파일의 하단에 배치하는 footer 텍스트를 지정합니다. footer는, 하부 네비게이션 바의 우측으로 배치됩니다. footer 에는, HTML 태그와 공백을 포함할 수가 있습니다만, 이것들을 포함하는 경우는, 전체를 인용부호로 둘러싸지 않으면 안됩니다. footer 중(안)에서 인용부호를 사용하는 경우는, 인용부호를 이스케이프 할 필요가 있습니다.
- -bottom text
- 각 출력 파일의 최하부에 배치하는 텍스트를 지정합니다. 이 텍스트는, 하부 네비게이션 바보다 아래의, 페이지의 최하부에 배치 . text 에는, HTML 태그와 공백을 포함할 수가 있습니다만, 이것들을 포함하는 경우는, 전체를 인용부호로 둘러싸지 않으면 안됩니다. text 중(안)에서 인용부호를 사용하는 경우는, 인용부호를 이스케이프 할 필요가 있습니다.
- -link extdocURL
- javadoc 에 의해 생성된 기존의외부 참조 클래스의 다큐멘테이션에의 링크를 작성합니다. 인수를 1 개 취합니다.
- extdocURL 는, 링크처로서 지정하는, javadoc 에 의해 생성된 외부 문서를 포함한 디렉토리의 절대 URL 또는 상대 URL 입니다. 나중에예를 나타냅니다. 이 디렉토리내에패키지 리스트파일이 존재하고 있지 않으면 안됩니다. 존재하지 않는 경우는,
-linkoffline 를 사용합니다. Javadoc 툴은,팍 케이지 리스트파일로부터 패키지명을 읽어내, 이러한 패키지를 그 URL 에 링크합니다. Javadoc 툴을 실행하면(자), 작성되는 <A HREF> 링크내에 extdocURL 의 값이 그대로 카피됩니다. 따라서,extdocURL 는 파일에의 URL 는 아니고 「디렉토리에의 URL」가 아니면 안됩니다.extdocURL 에의 절대 링크를 사용하면(자), 유저의 문서를 임의의 Web 사이트상의 문서에 링크할 수 있습니다. 상대 위치에 링크하는 것만으로 좋은 경우는 상대 링크를 사용할 수 있습니다. 상대 링크를 사용하는 경우,-d (을)를 사용해, 생성처 디렉토리로부터 링크되는 패키지가 있는 디렉토리의 상대 패스를 지정할 필요가 있습니다.
통상, 절대 링크를 지정하는 경우는,http: 링크를 사용합니다. Web 서버를 가지지 않는 파일 시스템에 링크하는 경우는,file: 링크를 사용할 수 있습니다. 다만, 이 방법은, 모든 유저가 생성된 같은 파일 시스템을 공유하는 문서에 액세스 할 필요가 있는 경우 이외는 사용하지 말아 주세요.
모든 경우, 모든 operating system로, 절대 URL 와 상대 URL, 「http:」베이스와 「file:」베이스에 관계없이, slash를 단락지어 문자로서 사용합니다 (URL Memo 로 지정).
- http: 베이스의 절대 링크:
-link http://<host>/<directory>/<directory>/.../<name>- file: 베이스의 절대 링크:
-link file://<host>/<directory>/<directory>/.../<name>- 상대 링크:
-link <directory>/<directory>/.../<name>
javadoc 의 실행시에복수의 -link 옵션을 지정해, 복수의 문서에의 링크를 작성할 수도 있습니다.
-linkoffline 와 -link 의 선택-
다음과 같은 경우는,-link 옵션을 사용합니다.
- 외부 API 문서에의 상대 패스를 사용하는 경우
- 외부 API 문서에의 절대 URL 를 사용하는 경우 (프로그램이 그 URL 에 접속해, 독해를 실시하는 것이 쉘에 의해 허가되고 있는 경우)
다음과 같은 경우는,-linkoffline 옵션을 사용합니다.
- 외부 API 문서에의 절대 URL 를 사용하는 경우 (프로그램이 그 URL 에 접속해, 독해를 실시하는 것이 쉘에 의해 허가되어 있지 않은 경우). 이러한 상황은, 링크처의 문서가 파이어 월(fire wall)의 저쪽 편에 있는 장소 합에 발생한다
외부 문서에의 절대 링크의 사용예 - http://java.sun.com/j2se/1. 4.2/docs/api 안의java.lang,java.io, 그 외의 Java 2 플랫폼 패키지에 링크하고 싶은 경우가 있습니다. 다음의 커멘드는,com.mypackage 패키지의 문서와 Java 2 플랫폼 패키지에의 링크를 생성합니다. 생성된 문서에는, 예를 들어 클래스 트리내의 Object 클래스에의 링크가 포함되어 있습니다. (-sourcepath 나 -d 등의 다른 옵션은 표시되지 않는다)
% javadoc -link http://java.sun.com/j2se/1. 4.2/docs/api com.mypackage
외부 문서에의 상대 링크의 사용예 - 2 개의 패키지가 있어, 그 문서가 Javadoc 툴을 여러 차례 실행한 결과 생성된 것이다고 합니다. 게다가 이러한 문서가 상대 패스로 분할되고 있다고 합니다. 이 예의 경우, 2 개의 패키지는, API 인 com.apipackage 와 SPI (서비스 프로바이더 인터페이스) 인com.spipackage 입니다. 문서의 포함처는 docs/api/com/apipackage 패키지와docs/spi/com/spipackage 패키지입니다. API 패키지의 문서가 벌써 생성되고 있어, 현재의 디렉토리가docs 인 경우, 다음의 커멘드를 실행하는 것에 의해, 이 API 문서에의 링크를 가지는 SPI 패키지를 문서화합니다. % javadoc -d . /spi -link ../api com.spipackage
-link 인수는, 생성처 디렉토리 (docs/spi) 의 상대 패스입니다.
상세 - -link 옵션을 사용하면(자), 「코드로부터는 참조되고 있어도, Javadoc 의 이번 실행에서는 문서화 되지 않는다」클래스에 링크할 수 있게 됩니다. 링크로부터 유효한 페이지로 이동할 수 있도록(듯이) 하려면 , 그러한 HTML 페이지가 있는 장소를 조사해 그 자리소를 extdocURL (으)로 지정할 필요가 있습니다. 이 옵션을 사용하면(자), 예를 들어, 써드파티의 문서로부터,http://java.sun.com 에 있는 java. * 의 문서에 링크할 수가 있습니다.
이번 실행으로 Javadoc 에 의해 생성되는 문서내의 API 만을 대상으로 링크를 작성하는 경우는,-link옵션을 생략 합니다. -link 옵션이 지정되어 있지 않은 경우, Javadoc 툴은, 외부 참조된 문서에의 링크를 작성하지 않습니다. 이것은, 그 문서가 존재할지 어떨지, 및 존재하는 경우는 그 자리소를 판별 성과 없기 때문입니다.
이 옵션에서는, 생성 문서내의복수의 장소에 링크를 작성할 수 있습니다.
또, 이 옵션을 사용하면(자), 복수의 패키지군의 사이에크로스 링크를 작성 할 수도 있습니다. 즉, 어느 일식의 패키지에 대해서 javadoc 를 실행한 뒤, 다른 일식의 패키지에 대해서 javadoc (을)를 실행해, 이것들 2 개의 패키지군의 사이에 크로스 링크를 작성할 수 있습니다.
클래스의 참조 방법 - 외부 참조 클래스에의 링크를, 텍스트 라벨 만이 아니고 실제로 표시하려면 , 다음의 방법으로 클래스를 참조할 필요가 있습니다. 메소드의 본체로 클래스를 참조 하는 것 만으로는 충분하지는 않습니다. import 문 또는 선언으로 참조할 필요가 있습니다. 다음에, 클래스 java.io.File(을)를 참조하는 방법의 예를 나타냅니다.
- 모든 종류의
import 문의 경우: 와일드 카드에 의한 임포트, 이름에 의한 명시적인 임포트, 또는java.lang. * 에 대한 자동적인 임포트. 예를 들어, 다음과 같이 하면 충분합니다.
import java.io. *;
1.3.x 및 1.2.x 에서는, 이름에 의한 명시적인 임포트 뿐입니다. 와일드 카드에 의한 임포트문도, 자동 임포트 java.lang. * 도 사용할 수 없습니다.
- 선언의 경우:
void foo(File f) {}
이 참조를 사용해, 메소드, constructor , 필드, 클래스, 또는 인터페이스의 리턴 타입 또는 파라미터 타입에 두는지, implements,extends 문장 또는 throws 문에 둡니다.
이 결과,-link 옵션을 사용해도, 이 제한을 위해서(때문에) 잘못해 표시되지 않는 많은 링크가 다수 발생할 가능성이 있습니다. 텍스트는 하이퍼 텍스트(hyper text) 링크를 뒤따를 수 있고 하지않고서 표시됩니다. 이러한 링크가 표시하는 경고로부터, 이 링크를 인식할 수 있습니다. 클래스를 올바르게 참조해, 거기에 따라 링크를 추가하기 위한 좀 더도 안 전인 방법은 위에서 설명했던 대로, 해당의 클래스를 임포트 하는 것입니다.
패키지 리스트 - -link 옵션은,package-list 라는 이름의 파일을 요구합니다. 이 파일은, Javadoc 툴에 의해 생성되어-link 에 의해 지정한 URL 에 존재합니다. package-list 파일은, 그 자리소에 있는 문서화 된 패키지의 이름의 리스트가 들어간 단순한 텍스트 파일입니다. 전의예에서는,Javadoc 툴은 지정된 URL 에 있는 package-list (이)라는 이름의 파일을 찾아, 패키지명을 읽어들여, 그 URL 에 있는 그러한 패키지에의 링크를 작성했습니다.
예를 들어, Java 2 Platform v1. 4 API 의 패키지 리스트는 http://java.sun.com/j2se/1. 4.2/docs/api/package-list 에 있어, 다음과 같은 내용으로 시작되어 있습니다.
java.applet
java.awt
java.awt.color
java.awt.datatransfer
java.awt.dnd
java.awt.event
java.awt.font
etc.
-link 옵션을 지정하지 않고 javadoc 를 실행했을 경우,외부 참조 클래스에 속하는 이름을 찾아내면(자),javadoc (은)는 그 이름을 링크를 가지지 않는 형태로 출력합니다. 한편,-link 옵션을 지정했을 경우는, 지정한 extdocURL 에 있는 package-list 파일로부터 해당하는 패키지명이 검색됩니다. 패키지명이 발견되면(자),extdocURL 하지만 이름의 전에 부가됩니다.
모든 링크가 올바르게 기능하기 위해서는, 외부 참조의 모든 문서가, 지정한 URL 에 존재하고 있지 않으면 안됩니다. Javadoc 툴은, 지정된 package-list 가 존재할지 어떨지를 조사하는 것만으로, 지정되었다 URL 에 목적의 페이지가 존재할지 어떨지는 체크하지 않습니다.
복수의 링크 - 복수의 -link 옵션을 지정하면(자), 생성된 임의의 수의 외부 문서에 대해서 링크를 설정할 수 있습니다. Javadoc 1.2 에는, 복수의 -link 옵션을 지정할 수 없다고 하는 버그가 있습니다. 이것은 1.2. 2 로 수정되었습니다.
링크하는 외부 문서 마다, 다음과 같이 다른 링크 옵션을 지정합니다.
% javadoc -link extdocURL1 -link extdocURL2 ...-link extdocURLn com.mypackage
extdocURL1, extdocURL2, ... extdocURLn (은)는, 각각 외부 문서의 루트를 가리켜, 각 루트에는package-list (이)라는 이름의 파일이 들어가 있습니다.
크로스 링크 - 아직 생성되어 있지 않은 2 개이상의 문서를 크로스 링크하는 경우는, 「bootstrap」가 필요하게 됩니다. 즉, 어느 문서에 대해서도 package-list 하지만 존재하고 있지 않는 경우는, 최초의 문서에 대해서 javadoc 툴을 실행하는 시점에서, 2 번째의 문서의 package-list 하지만 아직 존재하고 있습니다. 따라서, 외부 링크를 작성하려면 , 2 번째의 문서를 생성한 후에, 최초의 문서를 다시 생성할 필요가 있습니다.
이 경우, 최초의 문서 생성의 목적은, 그 문서의 package-list (을)를 작성하는 것입니다. 패키지명을 모두 파악하고 있는 경우는, package-list 를 수동으로 작성할 수도 있습니다. 다음에, 2 번째의 문서와 그 외부 링크를 생성합니다. 필요한 외부의 package-list 파일이 존재하지 않는 경우, Javadoc 툴은 경고를 표시합니다.
- -linkoffline extdocURL packagelistLoc
- 이 옵션은,
-link 옵션을 바꾼 것입니다. 어느쪽이나, javadoc 에 의해 생성되었다외부 참조 클래스의 문서에의 링크를 작성합니다. Javadoc 툴 자체가 오프 라인이 되어 있을 때 (Web 접속을 사용해 문서에 액세스 할 수 없을 때), Web 상의 문서에 링크하려면 ,-linkoffline 옵션을 사용합니다.엄밀하게는, 외부 문서의 package-list 파일에 액세스 할 수 없을 때, 또는 이 파일이 extdocURL 로 지정된 장소와는 다른 장소 (통상,packageListLoc 그리고 지정 가능한 로컬인 장소)에 존재할 때,-linkoffline 를 사용합니다. 따라서,extdocURL 에 WWW 상에서 밖에 액세스 할 수 없는 경우는,-linkoffline 를 지정하는 것으로써, 문서의 생성시에 javadoc 툴이 Web 에 접속할 수 없으면 안 된다고 하는 제약이 없어집니다.
게다가문서를 갱신하기 위한 「해킹」으로서의 사용도 가능합니다. 팍케이 지세트 전체에 대해서 javadoc 를 실행한 뒤, 변경한 일부의 패키지인 만큼 대해 javadoc (을)를 실행합니다. 이렇게 해, 갱신된 파일을, 오리지날의 파일 세트에 삽입할 수 있도록(듯이) 합니다. 예를 나중에 가리키겠습니다.
-linkoffline 옵션은 인수를 2 개 취합니다. 최초의 인수는 <a href> 링크에 짜넣어지는 캐릭터 라인을 지정하는 인수, 2 번째의 인수는 package-list 의 검색 장소를 지정하는 인수입니다.
- extdocURL 는, 링크처로서 지정하는, javadoc 에 의해 생성된 외부 문서를 포함한 디렉토리의 절대 URL 또는 상대 URL 입니다. 상대 링크를 사용하는 경우,
-d (을)를 사용해, 생성처 디렉토리로부터 링크되는 패키지의 루트의 상대 패스를 지정할 필요가 있습니다. 자세한 것은,-link 옵션의 extdocURL 를 참조해 주세요.
- packagelistLoc 에는, 외부 문서의
package-list 파일이 들어가 있는 디렉토리의 패스 또는 URL 를 지정합니다. URL (http: 또는 file:) 또는 파일 패스를 지정할 수 있습니다. 또, 절대 패스와 상대 패스의 어디라도 괜찮습니다. 상대 패스의 경우는, javadoc 하지만 실행되는 커런트 디렉토리로부터의 상대 패스로 해서 지정합니다. package-list 그렇다고 하는 파일명은 포함하지 말아 주세요.
javadoc 의 1 회의 실행으로,복수의 -linkoffline 옵션을 지정할 수 있습니다. 1.2. 2 보다 전은, 복수의 옵션을 지정할 수 없었습니다.
외부 문서에의 절대 링크의 사 용례 - http://java.sun.com/j2se/1. 4.2/docs/api 내의java.lang,java.io, 그 외의 Java 2 플랫폼 패키지에 링크하고 싶지만, 쉘로부터 Web 에 액세스 할 수 없는 경우가 있습니다. 이 경우는, 브라우저로 http://java.sun.com/j2se/1. 4.2/docs/api/package-list 에 있는 package-list 파일을 열어, 로컬 디렉토리에 보존합니다. 게다가 2 번째의 인수packagelistLoc 에 이 로컬 카피의 장소를 지정합니다. 이 예에서는, 패키지 리스트 파일은 커런트 디렉토리 「. 」에 보존되고 있고 . 다음의 커멘드는, Java 2 플랫폼 API 에의 링크를 포함한,com.mypackage 패키지의 문서를 생성합니다. 생성된 문서에는, 예를 들어 클래스 트리내의 Object클래스에의 링크가 포함되어 있습니다. (-sourcepath 등의 다른 필요한 옵션은 표시되지 않는다)
% javadoc -linkoffline http://java.sun.com/j2se/1. 4.2/docs/api . com.mypackage
외부 문서에의 상대 링크의 사용예 - 통상,-linkoffline 에 상대 패스를 지정할 것은 없습니다. -link 로 같은 것이 생기기 때문입니다. -linkoffline (을)를 사용할 때,package-list 에는 통상 로컬의 파일을 지정합니다. 상대 링크를 사용할 때도, 링크처의 파일에는 통상 로컬의 파일을 지정합니다. 따라서,-linkoffline 의 2 개의 인수에 다른 패스를 지정할 필요는 없습니다. 2 개의 인수가 동일한 경우는,-link 를 사용할 수 있습니다. -link 의 상대 링크의 예를 참조해 주세요.
package-list 파일을 수동으로 작성 - package-list 파일이 아직 존재하지 않아도, 문서의 링크처의 패키지명을 알 수 있고 있는 경우는, 이 파일을 스스로 작성해,packagelistLoc 그리고 그 패스를 지정할 수가 있습니다. com.apipackage 가 최초로 생성되어com.spipackage 의 패키지 리스트가 존재하지 않는다고 하기 전출의 예를 참조해 주세요. 이 방법은, 패키지명은 알고 있지만, 아직 공개되어 있지 않은, 새로운 외부드 큐먼트에 링크하는 문서를 생성할 필요가 있는 경우에 편리합니다. 또,package-list파일이 생성되지 않는 Javadoc 1.0 이나 1.1 등으로 생성된 패키지전용으로 package-list 파일을 작성할 경우에도, 이 방법을 이용합니다. 같이 2 개의 회사가 미공개의 package-list 파일을 공유할 수도 있기 (위해)때문에, 크로스 링크를 설정한 문서를 동시에 릴리스 하는 일도 가능합니다.
복수의 문서에의 링크 - -linkoffline (은)는, 참조처의 생성 문서 마다 1 개(살)씩 지정합니다. 다음의 예에서는, 알기 쉽게 하기 위해서 옵션 마다 행을 나누고 있습니다.
% javadoc -linkoffline extdocURL1 packagelistLoc1 \
-linkoffline extdocURL2 packagelistLoc2 \
...
문서의 갱신 - 전술의 -linkoffline 옵션의 또 하나의 용도는, 프로젝트에 대량의 패키지가 포함되어 있어, 벌써 트리 전체에 대해서 javadoc 의 실행이 완료하고 있는 경우에, 다음의 실행에서는, 소량의 변경을 재빠르게 더한 뒤, 소스 트리의 매우 일부에 대해서 만여라 javadoc (을)를 재실행하는 경우에 편리합니다. 이것은, 다큐멘테이션 코멘트에 대해서만 변경을 더해 선언은 변경하지 않는 경우에게만 올바르게 처리되므로, 학킨 그와 같은 것입니다. 원시 코드의 선언을 추가, 삭제, 또는 변경했을 경우는, 색인, 패키지 트리, 상속되는 멤버의 리스트, 「사용」페이지등의 장소에서, 링크가 망가지는 일이 있습니다.
우선, 이번 실행으로 사용하는 새로운 생성처 디렉토리 (update) (을)를 작성합니다. 원의 생성처 디렉토리의 이름이 html 라고 합니다. 무엇보다 단순한 예에서는,html 디렉토리의 친디렉토리에 이동 (cd)합니다. -linkoffline 의 최초의 인수에 커런트 디렉토리 「.」(을)를 지정해, 2 번째의 인수에 html 에의 상대 패스를 지정합니다. 여기서,package-list 하지만 검색됩니다. 갱신 대조의 패키지의 패키지명만을 지정해 주세요.
% javadoc -d update -linkoffline . html com.mypackage
Javadoc 툴의 종료후,update/com/package 내의 생성된 클래스의 페이지를 카피해 (개요나 색인을 제외하다),html/com/package 내의 원의 파일에 덧쓰기합니다.
- -linksource
- 각 원시 파일 (행 번호 첨부)의 HTML 버젼을 작성해, 표준 HTML 문서로부터 원시 파일에의 링크를 추가합니다. 링크는, 원시 파일내에 선언되고 있는 클래스, 인터페이스, constructor , 메속 드, 필드에 대해서 작성됩니다. 디폴트 constructor , 생성된 클래스에 대해서는 작성되지 않습니다.
이 옵션은,-public,-package,-protected,-private 의 각 옵션과는 관계없이, 비공개의 클래스, 필드, 비공개의 메소드의 본체를 시작으로 하는 짜넣어진 원시 파일내의 모든 비공개 구현의 상 세를 공개합니다. -private 옵션을 지정하지 않는 한, 비공개의 클래스나 인터페이스의 일부에는, 링크를 개입시켜 액세스 할 수 없는 것이 있습니다.
각 링크는, 그 선언내의 식별자명 위에 작성됩니다. 예를 들어,Button 클래스의 소스코드헤의 링크는, 「Button」라고 하는 말 위에 작성됩니다.
public class Button
extends Component
implements Accessible
Button 클래스의 getLabel() 메소드의 원시 코드에의 링크는, 「getLabel」라고 하는 말 위에 작성됩니다. public String getLabel()
- -group groupheading packagepattern
:packagepattern:... - 개요 페이지의 복수의 패키지를, 지정한 그룹으로 나누어, 그룹 마다 겉(표)를 작성합니다. 각 그룹은, 각각 다른
-group 옵션으로 지정합니다. 이러한 그룹은, 커멘드행으로 지정한 순서로 페이지에 표시됩니다. 각 그룹내에서는, 패키지가 알파벳순서에 늘어놓고 . 지정한 -group 옵션 마다,packagepattern식의 리스트와 일치하는 패키지가, 표제 groupheading 를 가지는 1 개의 표에 정리해 표시됩니다.
- groupheading 에는, 임의의 텍스트를 지정할 수 있어 공백을 포함할 수가 있습니다. 지정한 텍스트는, 그룹의 표견 방편이 됩니다.
- packagepattern 에는, 임의의 패키지명, 또는 임의의 패키지명의 선두 부분과 거기에 계속되는 1 개의 asterisk (
*) (을)를 지정할 수 있습니다. asterisk는, 「임의의 문자에 일치한다」라고 하는 의미의 와일드 카드입니다. 와일드 카드로서 지정할 수 있는 것은, asterisk만으로 . 1 개의 그룹에는, 구두점 (:)으로 단락지어 복수의 패턴을 포함할 수가 있습니다.
주: 패턴이나 패턴 리스트내에서 asterisk를 사용하는 경우는,"java.lang*:java.util" (와)과 같이, 패턴 리스트를 인용부호로 둘러쌀 필요가 있습니다.
-group 옵션이 지정되어 있지 않은 경우는, 모든 패키지가, 「패키지」라고 하는 표제의 1 개의 그룹에 넣어집니다. 문서화 되는 패키지안에, 지정한 그룹의 어느 그룹에도 들어가지 않는 패키지가 있는 경우, 이러한 팍 케이지는 「그 외의 패키지」라고 하는 표제를 가지는 독립한 그룹에 넣어집니다.
예를 들어, 다음과 같이 옵션을 지정하면(자), 문서화 되는 5 개의 패키지는, 코어 패키지, 확장 기능 패키지, 및 그 외의 패키지로 나눌 수 있습니다. 「java.lang*」에서는, 마지막 닷을 지정해 (이)라고 없는 것에 주목해 주세요. 「java.lang. *」(와)과 같이 닷을 넣으면(자), java.lang 패키지는 제외되게 됩니다.
% javadoc -group "Core Packages" "java.lang*:java.util"
-group "Extension Packages" "javax. *"
java.lang java.lang.reflect java.util javax.servlet java.new
이 결과, 다음과 같은 그룹화를 합니다.- 코어 패키지
java.langjava.lang.reflectjava.util- 확장 기능 패키지
javax.servlet- 그 외의 패키지
java.new
- -nodeprecated
- 추천 되지 않는 API 를 문서에 생성하지 않게 합니다. 이 옵션을 지정하면(자), -nodeprecatedlist 옵션을 지정했을 경우와 같은 효과가 있는 것에 가세해, 문서외의 부분 전체에서도, 추천 되지 않는 API 하지만 생성되지 않습니다. 이 옵션은, 코드를 기술하고 있을 때, 추천 되지 않는 코드에 의해 기분을 가라앉혀진 구 없는 경우에 편리합니다.
- -nodeprecatedlist
- 추천 되지 않는 API 의 리스트를 포함한 파일 (deprecated-list.html), 및 네비게이션 바의 그 페이지로의 링크가 생성되지 않게 합니다. 다만, 문서 인가의 부분에서는, 추천 되지 않는 API 가 생성됩니다. 이 옵션은, 추천 되지 않는 API 하지만 원시 코드에 포함되지 않고, 네비게이션 바를 깨끗이보여 주고 싶은 경우에 편리합니다.
- -nosince
- 생성 문서로부터,@since 태그에 대응하는 「도입된 버젼」섹션을 생략 합니다.
- -notree
- 생성 문서로부터, 클래스 및 인터페이스의 계층 페이지를 생략 합니다. 이러한 페이지는, 네비게이션 바의 「Tree」보타 를 사용한다고 표시됩니다. 디폴트에서는, 계층이 생성됩니다.
- -noindex
- 생성 문서로부터, 색인을 생략 합니다. 디폴트에서는, 색인이 생성됩니다.
- -nohelp
- 출력의 각 페이지의 최상부와 최하부에 있는 네비게이션 바로부터 「헬프」링크를 생략 합니다.
- -nonavbar
- 생성되는 페이지의 최상부와 최하부에 표시되는 네비게이션 바, 헤더, 및 footer를 생성하지 않게 합니다. 이 옵션은, bottom 옵션에는 영향을 주지 않습니다.
-nonavbar 옵션은, 인쇄하기 위해(때문에)인 만큼 파일을 PostScript 또는 PDF 로 변환하는 경우 등, 내용만이 중요해, 네비게이션의 필요가 없는 경우에 편리합니다.
- -helpfile path/filename
- 상부와 하부의 네비게이션 바의 「헬프」링크의 링크처가 되는 대체 헬프 파일 path/filename 의 패스를 지정합니다. 이 옵션이 지정되어 있지 않은 경우, Javadoc 툴은, 하드 코드 되고 있는 헬프 파일
help-doc.html (을)를 자동적으로 작성합니다. 이 옵션을 사용하면(자), 그 디폴트의 동작을 오버라이드(override) 할 수 있습니다. filename 에는 어떤 파일명이라도 지정할 수 있어help-doc.html 에는 한정되지 않습니다. Javadoc 툴은, 이 옵션에서의 지정에 따라, 네비게이션 바에 있는 링크에 조정을 더합니다. 다음에 예를 나타냅니다. % javadoc -helpfile /home/user/myhelp.html java.awt
- -stylesheetfile path/filename
- 대체 HTML 스타일 시트 파일의 패스를 지정합니다. 이 옵션이 지정되어 있지 않은 경우, Javadoc 툴은, 하드 코드 되고 있는 스타일 시트 파일
stylesheet.css (을)를 자동적으로 작성합니다. 이 옵션을 사용하면(자), 그 디폴트의 동작을 오버라이드(override) 할 수 있습니다. filename 에는 어떤 파일명이라도 지정할 수 있어stylesheet.css 에는 한정되지 않습니다. 다음에 예를 나타냅니다. % javadoc -stylesheetfile /home/user/mystylesheet.css com.mypackage
- -serialwarn
- @serial 태그가 없는 경우는, 컴파일시에 경고를 생성합니다. 디폴트에서는, Javadoc 1.2. 2 이후의 버젼에서는, 직렬화의 경고는 생성되지 않습니다 1.2. 2 보다 전의 초기 버젼에서는, 경고가 생성됩니다. 이 옵션을 사용하면(자), 직렬화의 경고가 표시되므로, 디폴트의 직렬화 가능 필드와
writeExternal 메소드를 적절히 문서화하는데 도움이 됩니다.
- -charset name
- 이 문서용의 HTML 캐릭터 세트를 지정합니다. 이 이름은,IANA Registry 그리고 주어진, 추천 되는 MIME 명이 아니면 안됩니다. 다음에 예를 나타냅니다.
% javadoc -charset "iso-8859-1" mypackage
생성되는 모든 페이지의 선두에, 다음의 행이 삽입됩니다. <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
이 META 태그에 대해서는,HTML 의 표준 (4197265 및 4137321)(을)를 참조해 주세요.-encoding 및 -docencoding 도 참조해 주세요.
- -docencoding name
- 생성되는 HTML 파일의 인코딩을 지정합니다. 이 이름은,IANA Registry 그리고 주어진, 추천 되는 MIME 명이 아니면 안됩니다. 이 옵션을 생략 하면서 -encoding (을)를 사용했을 경우, 생성되는 HTML 파일의 encode는, -encoding 에 의해 결정할 수 있습니다. 다음에 예를 나타냅니다.
% javadoc -docencoding "ISO-8859-1" mypackage
-encoding 및 -charset 도 참조해 주세요.
- -keywords
- HTML 메타키워드타그를, 클래스 마다 생성되는 파일에 추가합니다. 이러한 태그는, 메타타그를 검색하는 써치엔진이 페이지를 찾아내는 경우에 도움이 되어 . 인터넷 전체를 검색하는 많은 써치엔진은, 페이지가 메타타그를 오용 하고 있기 (위해)때문에, 메타타그를 조사하지 않습니다. 한편, 검색을 자신의 Web 사이트로 한정하고 있는 기업에서는, 써치엔진이 메타타그를 조사하는 것에 의해 메리트를 얻을 수 있습니다.
메타타그에는, 클래스의 완전 수식명과 필드 및 메소드의 수식되어 있지 않은 이름이 포함됩니다. constructor 은, 클래스명과 동 글자이기 (위해)때문에 포함되지 않습니다. 예를 들어, 클래스 String 는 다음의 키워드로 개시합니다.
<META NAME="keywords" CONTENT="java.lang.String class">
<META NAME="keywords" CONTENT="CASE_INSENSITIVE_ORDER">
<META NAME="keywords" CONTENT="length()">
<META NAME="keywords" CONTENT="charAt()">
- -tag tagname
:Xaoptcmf:"taghead" - Javadoc 툴이 다큐멘테이션 코멘트내의 인수를 1 개 취하는 단순한 커스텀브 락 태그
@tagname 를 해석할 수 있도록(듯이) 합니다. 이것에 의해, Javadoc 툴은 태그명의 「스펠링」을 실시할 수가 있으므로, 원시 코드 안의 모든 커스텀 태그에 -tag 옵션을 짜넣는 것을 추천합니다. 이번 실행으로 출력되지 않는 태그는,X (을)를 붙여무효로 합니다.구두점 (:)은 항상 단락지어 문자가 됩니다. tagname 그리고 구두점을 사용하려면 ,「태그명에서의 구두점의 사용」을 참조해 주세요.
-tag 옵션은, 태그의 표제 「taghead」를 굵은 글씨로 출력합니다. 그 다음의 행에는, 이 옵션의 인수로 지정한 텍스트가 계속됩니다. 이하의예를 참조해 주세요. 블록 태그와 같이, 이 인수의 텍스트에는 인 라인 태그를 포함하는 것이로 옵니다. 이 인 라인 태그도 해석됩니다. 출력은, 인수를 1 개 취하는 표준의 태그 (@return,@author 등)의 출력과 자주(잘) 닮았습니다. taghead 를 생략 하면(자),tagname가 표제로서 표시됩니다.
태그의 배치 - 인수의 Xaoptcmf 부분은, 원시 코드내의 태그를 배치할 수 있는 위치와X (을)를 사용해 이 태그를 무효로 할 수 있을지 어떨지를 특정합니다. 태그의 배치 위치를 제한하지 않는 경우는 a(을)를 지정합니다. 그 이외의 문자의 편성도 가능합니다.
X (태그의 무효화)
a (모든 위치)
o (개요)
p (패키지)
t (형태 즉 클래스 및 인터페이스)
c (constructor )
m (메소드)
f (필드)
싱글 태그의 예 - 원시 코드내의 임의의 위치에서 사용으로 기분태그의 태그 옵션의 예를 나타냅니다.
-tag todo:a:"To Do:"
@todo 를 constructor , 메소드, 필드만으로 사용하는 경우는, 이하의 옵션을 사용합니다. -tag todo:cmf:"To Do:"
위의 예의 마지막 구두점 (:)은, 파라미터 단락자입니다만, 표제 텍스트의 일부가 되어 있습니다 (이하의 예를 참조). 다음의 예의 같게,@todo 태그를 포함한 원시 코드에서는, 몇개의 태그 옵션을 사용합니다. @todo The documentation for this method needs work.
이 행은, 다음과 같은 출력을 생성합니다.- To Do:
- The documentation for this method needs work.
태그명에서의 구두점의 사용 - 구두점은, backslash로 이스케이프 하면(자), 태그 나우치에서 사용할 수 있습니다. 다음의 다큐멘테이션 코멘트를 예를 듭니다. /**
* @ejb:bean
*/
다음의 태그 옵션을 사용합니다. -tag ejb\\:bean:a:"EJB Bean:"
태그명의 스펠링 (태그의 무효화) - 원시 코드내에 배치한 일부의 커스텀 태그의 출력을 억제하고 싶은 경우가 있습니다. 이 경우도, 원시 코드내에 모든 태그를 배치해, 출력을 억제하지 않는 타 그를 유효하게 해, 출력을 억제하는 태그를 무효로 합니다. 태그를 무효로 하려면 ,X (을)를 지정합니다. 지정하지 않으면 그 태그는 유효하게 됩니다. 이것에 의해, Javadoc 툴은, 검출한 태그가 입력 미스등에 의한 미지의 태그일지 어떨지를 특정할 수 있습니다. 미지의 태그를 검출했을 경우, Javadoc 툴은 경고를 출력합니다.벌써 배치되고 있는 값에 X 를 추가할 수 있습니다. 이렇게 해 두면,X (을)를 삭제하는 것만으로 태그를 유효하게 할 수가 있습니다. 예를 들어, @todo 태그의 출력을 억제하고 싶은 경우, 다음과 같이 지정합니다.
-tag todo:Xcmf:"To Do:"
한층 더 단순한 지정 방법도 있습니다. -tag todo:X
구문 -tag todo:X 는,@todo 가 taglet 그리고 정의되고 있는 경우도 유효합니다.
태그의 순서 - -tag ( 및 -taglet ) 옵션의 순서에 의해, 그 출력 순서가 결정됩니다. 커스텀 태그와 표준 태그를 조합해 사용할 수도 있습니다. 표준 태그의 태그 옵션은, 순서 (을)를 결정하기 (위해)때문에만의 플레이스홀더입니다. 이것들은 표준 태그명만을 사용합니다. (표준 태그의 부표제는 변경할 수 없다. ) 이것에 대해서는, 이하의 예로 설명 합니다.
-tag 가 없는 경우,-taglet 의 위치에 의해 그 순서가 결정됩니다. 태그가 양쪽 모두 존재하는 경우, 커멘드행의 마지막에 있는 편이 그 순서를 결정합니다. 이것은, 태그나 태그 렛이 팽이 드행으로 지정된 차례로 처리되기 (위해)때문에입니다. 예를 들어,-taglet 와 -tag 의 양쪽 모두가 todo 라는 이름을 가지고 있는 경우, 커멘드행의 마지막에 있는 편이 순서를 결정합니다.
태그의 완전 세트의 예 - 이 예에서는, 출력의 「Parameters」와「Throws」의 사이에 「To Do」를 삽입합니다. X 를 사용해, @example 가, 원시 코드내의 이번 실행에서는 출력되지 않는 태그인 것을 지정합니다. @argfile (을)를 사용하는 경우는, 다음과 같이, 인수 파일내의 다른 행에 태그를 배치할 수 있습니다. 행의 계속을 나타내는 문자는 불필요합니다.
-tag param
-tag return
-tag todo:a:"To Do:"
-tag throws
-tag see
-tag example:X
javadoc 가 다큐멘테이션 코멘트를 해석할 때에 검출된 태그 가운데, 표준 태그에서도 -tag (이)나 -taglet 그리고 건네받는 태그도 아닌 것은, 미지의 태그라고 보여집니다. 이 경우, 경고가 슬로우 됩니다.
표준 태그는, 최초, 디폴트의 순서로 리스트내에 내부적으로 포함됩니다. -tag 옵션을 사용하면(자), 이 리스트에 추가되는 태그, 즉 표준 태그의 위치가 디폴트의 위치로부터 이동합니다. 즉, 표준 태그에 -tag 옵션을 붙이지 않으면, 이것들은 디폴트의 위치에 배치된 채로 있습니다.
경합의 회피 - 고유의 이름 공간을 슬라이스 하고 싶은 경우는, 패키지에 대해서 사용한 것 같은 닷 단락의 명명 규칙을 사용합니다 (예: com.mycompany.todo). Sun 는, 향후도 이름에 닷을 포함하지 않는 표준 태그를 작성합니다. 유저가 작성한 태그는, Sun 하지만 제공하는 같은 이름의 태그의 동작을 오버라이드(override) 합니다. 즉, 유저가 @todo (이)라는 이름의 태그 또는 태그 렛을 작성한 경우, Sun 하지만 나중에 같은 이름의 표준 태그를 작성해도, 그 태그 또는 태그 렛은 원의 동작을 보관 유지합니다.
-taglet 옵션을 사용해, 보다 복잡한 블록 태그 또는 커스텀 인 라인 태그도 작성할 수 있습니다.
- -taglet class
- 그 태그의 문서의 생성에 사용하는 도크 렛을 기동하기 위한 클래스 파일을 지정합니다. 클래스의 완전 지정명을 지정해 주세요. 이 태그 렛은, 커스텀 태그의 텍스트 인수의 수도 정의합니다. 태그 렛은, 이러한 인수를 받아들여 처리해, 출력을 생성합니다. 외부 문서와 샘플 태그 렛에 대해서는, 이하를 참조해 주세요.
태그 렛은, 블록 태그 또는 인 라인 태그로 편리합니다. 태그 렛은 임의의 수의 인수를 취할 수가 있습니다. 또, 텍스트를 굵은 글씨 (으)로 하는, 조목별로 나누어 쓴 글을 작성하는, 텍스트를 파일에 써내는, 그 외의 프로세스를 개시하는 등의 커스텀 동작을 구현할 수 있습니다.
태그 렛으로 지정할 수 있는 것은, 태그의 배치 장소와 배치 형식만입니다. 그 외의 모든 결정은, 도크 렛에 의해 행해집니다. 타그렉 트를 사용해도, 포함 클래스의 리스트로부터 클래스명을 삭제하는 등의 처리는 실행할 수 없습니다. 다만, 태그의 텍스트를 파일에 출력하거나 다른 프로세스를 방아쇠 하는 등의 부작용은 얻을 수 있습니다.
태그 렛의 패스를 지정하려면 ,-tagletpath 옵션을 사용합니다. 이하는, 생성되는 페이지의 「Parameter」와「Throws」의 사이에 「To Do」태그 렛을 삽입하는 예입니다.
-taglet com.sun.tools.doclets.ToDoTaglet
-tagletpath /home/taglets
-tag return
-tag param
-tag todo
-tag throws
-tag see
-tag 옵션 대신에 -taglet 옵션을 사용할 수도 있습니다만, 읽기 쉬움을 고려한다면,-tag 옵션을 사용하는 편이 좋을 것입니다.
- -tagletpath tagletpathlist
- taglet 클래스 파일 (. class)의 검색 패스를 지정합니다. tagletpathlist 에는, 구두점 (
:)으로 단락지어 복수의 패스를 포함할 수가 있습니다. Javadoc 툴은, 지정된 패스 이하의 모든 서브 디렉토리를 검색합니다.
- -docfilessubdirs
doc-files 디렉토리의 깊은 카피를 유효하게 합니다. 즉, 카피 먼저는, 서브 디렉토리와 모든 컨텐츠가 카피됩니다. 예를 들어,doc-files/example/images 디렉토리와 그 중의 파일이 카피됩니다. 여기에서도,서브 디렉토리를 제 밖 하는 지정이 가능합니다.
- -excludedocfilessubdir name1:name2...
- 소정의 이름의
doc-files 서브 디렉토리를 제외합니다. 이것에 의해, SCCS (와)과 그 외의 원시 코드 제어 서브 디렉토리의 카피를 막습니다.
- -noqualifier
all | packagename1:packagename2:... - 출력되는 클래스명의 선두의 패키지명 (패키지 수식자)을 생략 합니다.
-noqualifier 의 인수로서 all(을)를 지정했을 경우, 모든 패키지 수식자가 모두 생략 됩니다. 삭제하는 복수의 패키지명을 구두점으로 단락지어, 와일드 카드와 함께 지정하는 일도 할 수 있습니다. 클래스 또는 인터페이스명이 표시되는 위치로부터 패키지명이 삭제됩니다.다음의 예에서는, 모든 패키지 수식자를 생략 합니다.
-noqualifier all
다음의 예에서는, 패키지 수식자 java.lang 및 java.io 를 생략 합니다.
-noqualifier java.lang:java.io
다음의 예에서는, java 로 시작되는 패키지 수식자와 com.sun 라고 하는 서브 패키지 (javax 는 아니다)를 생략 합니다.
-noqualifier java. *:com.sun. *
위의 동작에 의해 패키지 수식자가 표시됩니다만, 이름은 적당 짧아집니다. 「이름이 표시되는 방법」을 참조해 주세요. 이 규칙은,-noqualifier 를 사용했는지 어떠했는지에 관계없이 유효합니다.
- -notimestamp
- 타임 스탬프를 억제합니다. 타임 스탬프는, 생성되는 HTML 의 각 페이지의 최상부 근처에 있는 HTML 코멘트안에 숨겨집니다. 이 옵션을 사용하면, 타임 스탬프에 의한 diff 가 발생하지 않게 되기 (위해)때문에, 2 개의 소스 베이스로 Javadoc 를 실행해, 이러한 소스 베이스를 구별하고 싶을 때에 도움이 됩니다 (이 옵션을 사용하지 않는 경우는, 페이지 마다 diff 하지만 발생한다). 타임 스탬프에는 Javadoc 버젼 번호가 포함되어 이 시점에서는, 다음과 같이 표시됩니다.
<! -- Generated by javadoc (build 1.5. 0-internal) on Tue Jun 22 09:57:24 PDT 2004 -->
- -nocomment
- 주설명 모든 태그를 포함한 코멘트 본체를 억제해, 선언만을 생성 섬 . 이 옵션을 사용하면(자), 다른 목적으로 작성된 원시 파일을 재이용해, 새로운 프로젝트의 초기 단계에서 스켈리턴 HTML 문서를 생성할 수 있습니다.
javadoc 의 커멘드행을 짧게 하거나 간결하게 하거나 하기 위해서,javadoc 커멘드에 대한 인수 (-J 옵션을 제외하다)가 들어간 1 개이상의 파일을 지정할 수가 있습니다. 이것을 이용하면, 어느 operating system상에서도, 임의의 길이의 javadoc 커멘드를 작성할 수 있습니다.인수 파일에는, Javadoc 옵션, 원시 파일명, 및 패키지명을 자유롭게 조합해 기술할 수 있습니다. 또, Javadoc 옵션에 대한 인수만을 기술해도 괜찮습니다. 파일내의 각 인수는, 스페이스 또는 개행으로 단락짓습니다. 인수 파일내의 파일명은, 현재의 디렉토리로부터 본 상대 패스가 됩니다. 인수 파일의 위치로부터 본 상대 패스가 아닙니다. 인수 파일내의 파일명 리스트에서는, 와일드 카드 (*)(은)는 사용할 수 없습니다. 예를 들어,*. java 와는 지정할 수 없습니다. 인수 파일내의 인수로 @ 문자를 사용해, 복수의 파일을 재귀적으로 해석하는 것은 서포트되고 있지 않습니다. 또,-J 옵션도 서포트되고 있지 않습니다. 이 옵션은 기동 툴에게 건네집니다만, 기동 툴에서는 인수 파일을 서포트하고 있지 않기 때문입니다.
javadoc 를 실행할 경우에, 각 인수 파일의 패스와 파일명의 선두에 @ 문자를 붙여 건네줍니다. javadoc 는,@ 문자로 시작되는 인수를 찾아내면(자), 그 파일의 내용을 전개해 인수 리스트에 삽입합니다.
인수 파일을 1 개 지정하는 예
argfile 라는 이름의 인수 파일에 모든 Javadoc 인수를 포함해, 다음과 같이 사용할 수가 있습니다. % javadoc @argfile
이 인수 파일에는, 다음의 예로 나타나고 있는 2 개의 파일의 내용을 양쪽 모두 들어갈 수 있을 수가 있습니다.인수 파일을 2 개 지정하는 예
Javadoc 옵션용으로 1 개(살), 원시 파일명용으로 1 개(살)과 같이, 2 개의 인수 파일을 작성해, 다음과 같이 해 사용할 수가 있습니다. 덧붙여 이후에의 리스트에서는, 행의 계속 문자를 사용하고 있습니다.이하의 내용을 포함한 options 라는 이름의 파일을 작성합니다.
-d docs-filelist
-use
-splitindex
-windowtitle 'Java 2 Platform v1. 3 API Specification'
-doctitle 'Java<sup><font size="-2">TM</font></sup> 2 Platform v1. 4 API Specification'
-header '<b>Java 2 Platform </b><br><font size="-1">v1. 4</font>'
-bottom 'Copyright 1993-2000 Sun Microsystems, Inc. All Rights Reserved. '
-group "Core Packages" "java. *"
-overview /java/pubs/ws/1. 3/src/share/classes/overview-core.html
-sourcepath /java/pubs/ws/1. 3/src/share/classes
이하의 내용을 포함한 packages 라는 이름의 파일을 작성합니다.
com.mypackage1
com.mypackage2
com.mypackage3
그 후, 다음의 커멘드를 사용해 javadoc 를 실행합니다. % javadoc @options @packages
패스 첨부의 인수 파일의 예
인수 파일에는, 패스를 지정할 수 있습니다. 다만, 그 파일내로 지정된 파일명은, 현재의 작업 디렉토리로부터 본 상대 패스가 됩니다. 즉, 아래의 예의 경우는,path1 나 path2 로부터 본 상대 패스가 아닙니다. % javadoc @path1/options @path2/packages
옵션의 인수의 예
다음에, Javadoc 옵션에 대한 인수만을 인수 파일에 포함하는 예를 나타냅니다. 여기에서는,-bottom (을)를 예에 채택합니다. 그 옵션에는, 꽤 긴 인수를 지정하는 것이 있기 때문입니다. 우선, 이 옵션의 텍스트 인수가 되는 다음과 같은 내용을 함 ,bottom 라는 이름의 파일을 작성합니다.
'<font size="-1"><a href="http://java.sun.com/cgi-bin/bugreport.cgi">Submit a
bug or feature</a><br><br>Java is a trademark or registered trademark of
Sun Microsystems, Inc. in the US and other countries. <br>Copyright 1993-2000 Sun
Microsystems, Inc. 901 San Antonio Road, <br>Palo Alto, California, 94303, U.S.A.
All Rights Reserved. </font>'
그 후, 다음과 같이 해 Javadoc 툴을 실행합니다. % javadoc -bottom @bottom @packages
또, 인수 파일의 선두에 -bottom 옵션을 짜넣어 두면, 다음과 같이 해 실행할 수 있습니다. % javadoc @bottom @packages
