gjdoc-4.8 - 클라우드의 온라인

프로그램:

이름

cp-tools - GNU 클래스 경로 도구 가이드

개요

gjdoc [-소스 경로 경로 목록]
[-모두] [-하위 패키지 패키지:패키지:...] [-들어오지 못하게 하다 pkglist]
[-부호화 문자셋] [-장소 name] [-source 공개]
[-공공의] [-보호] [-꾸러미] [-은밀한]
[-문서 제목 본문] [-헤더 본문] [-보행인 본문] [-맨 아래 본문]
[-링크 URL] [-링크오프라인 URL 통로] [-부적격자 패키지:패키지:...]
[-taglet경로 경로 목록] [-태그렛 className] [-꼬리표 태그 사양]
[-사용하다] [-링크 소스] [-분할 인덱스] [-NOINDEX] [-노트리]
[-번역] [-작가] [-nosince] [-스타일시트 추가 파일]
[-d 타겟디렉터리]
[패키지...] [소스파일...] [@cmd 파일]

gjdoc [-소스 경로 경로 목록]
[-모두] [-하위 패키지 패키지:패키지:...] [-들어오지 못하게 하다 pkglist]
[-부호화 문자셋] [-장소 name] [-source 공개]
[-공공의] [-보호] [-꾸러미] [-은밀한]
[-doclet경로 경로 목록] [-도클렛 className]
[패키지...] [소스파일...] [@cmd 파일]
[Doclet 옵션]

gjdoc --도움

gjdoc --번역

가장 유용한 옵션만 여기에 나열됩니다. 나머지는 아래를 참조하십시오.

기술

Gjdoc는 두 가지 방법으로 사용될 수 있습니다: 독립 실행형 문서 도구 또는
사용자 지정 Doclet.

기본 모드에서 Gjdoc은 Standard Doclet을 사용합니다. HtmlDoclet 세트를 생성하기 위해
HTML 페이지. 정식 사용법은 다음과 같습니다:

gjdoc -s src/java/ -all -d api-docs/

여기 소스/자바/ 소스 코드 클래스 계층 구조의 루트입니다. -모두 모두 유효하다는 뜻
이 루트 디렉터리에 있는 Java 파일은 처리되어야 하며, API 문서/ 이다
생성된 문서가 위치할 디렉터리입니다.

표준 Doclet 이외의 Doclet 실행에 대해 자세히 알아보려면 매뉴얼을 참조하세요.

옵션

선택권 요약 by 타입

다음은 Gjdoc과 Standard Doclet의 모든 옵션을 다음과 같이 그룹화하여 요약한 것입니다.
유형. 설명은 다음 섹션에 있습니다.

출처 세트 옵션
-소스 경로 경로 목록 -하위 패키지 pkglist -들어오지 못하게 하다 pkglist

출처 형성 옵션
-source 공개 -부호화 부호화 -파괴자

상호 연결 옵션
-링크 URL -링크오프라인 URL 파일 -부적격자 패키지:패키지:...

세대 옵션
-작가 -라이센스 텍스트 -사용하다 -번역 -분할 인덱스 -NOINDEX
-nodeprecated -노드 사용 목록 -도움말 없음 -nonavbar
-nosince -노트리 -공공의 -보호 -꾸러미 -은밀한
-docfiles하위 디렉터리 -excludedocfiles하위 디렉터리 이름
-링크 소스

산출 옵션
-d -장소 name -문자 집합 문자셋 -도센코딩 문자셋
-유효한 HTML -baseurl URL

장식 옵션
-창제목 본문 -문서 제목 본문 -제목 본문
-헤더 본문 -보행인 본문 -맨 아래 본문
-도움말 파일 파일 -스타일시트파일 파일 -스타일시트 추가 파일
-그룹 그룹헤딩 pkg패턴:pkg패턴:...

태그렛 옵션
-taglet경로 -태그렛 클래스 이름 -꼬리표 태그 사양

Doclet 옵션
-doclet경로 -도클렛 클래스 이름

다변 옵션
-조용한 -말 수가 많은

온라인 머신 옵션
-클래스 경로 -부트 클래스 경로 -J vmopt

선택 어느 출처 파일 에 방법

-s 경로 목록
-소스 경로 경로 목록
지정된 디렉터리에서 소스 파일을 찾습니다.

경로 목록 플랫폼 경로로 구분된 하나 이상의 디렉터리 경로여야 합니다.
구분 기호(보통 : or ;).

이 옵션이 주어지지 않으면, gjdoc 현재 소스 파일을 찾습니다.
디렉토리.

지정된 디렉터리는 Java 패키지 측면에서 루트 디렉터리여야 합니다.
체계. 예를 들어 패키지의 클래스에 대한 문서를 생성하려는 경우
푸.바, 최상위 레벨이 포함된 디렉토리를 지정해야 합니다. 푸 하위 디렉토리,
디렉토리가 아닙니다 푸/바/ Java 소스 파일이 있는 위치입니다.

약칭 별칭 -s 에 특정하다 gjdoc Sun과 호환되지 않음 자바독.

-모두
[실험적] 다음에 나열된 디렉토리에 있는 모든 유효한 Java 소스 파일을 처리합니다.
소스 경로와 해당 하위 디렉터리.

이는 특정 옵션입니다. gjdoc Sun과 호환되지 않음 자바독.

-하위 패키지 패키지:패키지:...
지정된 Java 패키지와 모든 하위 패키지의 클래스를 재귀적으로 처리합니다.
여러 패키지 이름은 공백 대신 콜론으로 구분해야 합니다.

-들어오지 못하게 하다 패키지:패키지:...
지정된 Java 패키지 및 모든 하위 패키지의 클래스를 반복적으로 처리하지 마세요.
이 옵션은 다음과 함께 사용할 수 있습니다. -모두 or -하위 패키지 제외하기 위해
출력의 개별 패키지 또는 패키지 하위 트리.

패키지...
지정된 Java 패키지의 모든 클래스를 처리합니다.

소스파일...
지정된 Java 소스 파일의 클래스를 처리합니다.

지정 전에, 형성 of 입력 파일

-source 공개
소스 파일이 특정 Java 플랫폼 릴리스를 대상으로 한다고 가정합니다.

공개 다음 형식의 Java 플랫폼 릴리스 버전 번호여야 합니다.
예를 들어 MAJOR.MINOR 1.4.

이 옵션은 현재 릴리스 번호가 다음과 같은 경우 오류가 발생한다는 점을 제외하면 무시됩니다.
이외의 1.2, 1.3 or 1.4 이 지정됩니다.

-부호화 문자셋
소스 파일이 다음을 사용하여 인코딩되었다고 가정합니다. 문자셋.

예 문자셋 are US-ASCII, ISO-8859-1 or UTF-8.

의미론 문자셋 의 것과 동일하다
java.nio.charset.Charset.forName(문자열).

-파괴자
내부 첫 번째 문장 대신 로케일의 java.text.BreakIterator를 사용하십시오.
탐지기.

기본적으로, gjdoc 문장이 끝나는 위치를 결정하기 위해 내부 알고리즘을 사용합니다. 언제
이 옵션이 주어지면 대신 java.text.BreakIterator 예를 들어
로케일 제공 -장소 (또는 기본 로캘).

이 옵션은 적용 시 지정되어야 합니다. gjdoc 주석이 달린 소스 코드에
기본 첫 문장 탐지기가 작동하지 않는 라틴어. 모든
다른 경우에는 기본값(BreakIterator를 사용하지 않음)이 더 나은 결과를 생성합니다.
이 글을 쓰는 시간.

상호 연결 과 other 문서 설정

-링크 URL
다른 문서 세트에 대한 하이퍼링크를 만듭니다.

기본적으로, gjdoc 소스 세트의 클래스에 대한 하이퍼링크만 생성합니다. 이것을 사용하십시오
지정된 클래스에 대한 하이퍼링크를 추가로 생성하는 옵션
문서 세트.

URL 다른 문서 세트의 루트 URL이어야 합니다. 예를 들어, 추가하려면
GNU 클래스 경로에 대한 하이퍼링크를 지정하려면 다음을 지정하십시오.

-링크 http://developer.classpath.org/doc/

XNUMXD덴탈의 -링크 옵션은 여러 번 지정할 수 있습니다.

다음을 지정하는 것에 유의하세요. -링크 옵션은 gjdoc가 실행될 때마다 HTTP 액세스를 발생시킵니다.
호출되었습니다. 당신이 사용할 수있는 -링크오프라인 대신 이 액세스를 방지합니다.

-링크오프라인 URL 파일
로컬 파일에도 있는 다른 문서 세트에 대한 하이퍼링크 생성
시스템.

이 옵션은 다음과 같이 작동합니다. -링크단, 로컬 파일 시스템에 액세스하는 경우는 제외됩니다.
링크된 클래스가 적용되는 클래스를 결정하기 위한 네트워크 대신
문서 세트.

사용시 -링크오프라인 원격 문서 세트에는 전혀 액세스할 수 없습니다.
네트워크 연결에 따라 생성 시간이 크게 단축됩니다. 그만큼
문서 세트에 대해 생성된 하이퍼링크는 원격 세트를 참조하는 것이지
더 이상 문서를 배포할 필요 없이 로컬 문서를 배포할 수 있습니다.
종속성.

XNUMXD덴탈의 -링크오프라인 옵션은 여러 번 지정할 수 있습니다.

-부적격자 패키지:패키지:...
해당 패키지 이름으로 지정된 패키지의 클래스 이름을 한정하지 마세요.

기본적으로 클래스 이름은 클래스가 클래스의 일부인 경우에만 정규화되지 않은 상태로 표시됩니다.
소스 세트 또는 링크된 문서 세트이며 해당 이름으로 한정됩니다.
패키지가 포함되어 있지 않은 경우. 이 옵션을 사용하여 정규화되지 않은 이름을 강제할 수 있습니다.
클래스가 문서 세트의 일부가 아니더라도 마찬가지입니다.

예를 들어, 일반적으로 String 클래스에 대한 참조는 다음과 같이 정규화되어 표현됩니다.
java.lang.문자열 (다음을 사용하여 적절한 문서 세트에 연결하지 않는 한 -링크)
문서 세트의 일부가 아니기 때문입니다. 지정할 수 있습니다 -부적격자
java.lang 동일한 참조를 렌더링하려면 끈.

정규화되지 않은 모든 클래스 이름의 경우 도구 설명이 제공됩니다.
HTML 문서에서 해당 항목 위에 마우스 포인터를 놓습니다.

-부적격자 모든
모든 클래스 이름에서 패키지 이름 한정자를 생략합니다.

패키지 이름 한정자를 모두 생략하려면 이 옵션을 지정합니다.

선택 어느 정보 에 생성

-공공의
출력에는 공개 클래스의 공개 멤버만 포함됩니다. 기본적으로 보호됨
학급 구성원도 포함됩니다.

-보호
출력에 공개 클래스의 공개 또는 보호 멤버를 포함합니다. 이것이
태만.

-꾸러미
public 및 package-private의 public, protected 및 package-private 멤버를 포함합니다.
수업.

-은밀한
액세스 수준에 관계없이 모든 클래스와 클래스 구성원을 포함합니다.

-분할 인덱스
단일 모놀리식 인덱스 페이지 대신 문자당 하나의 인덱스 페이지를 생성합니다.

기본적으로 표준 Doclet에 의해 생성된 색인에는 단일 항목의 모든 항목이 포함됩니다.
페이지. 작은 문서 세트에는 괜찮지만 큰 세트에는 다음을 수행해야 합니다.
이 옵션을 지정합니다.

-nosince
무시 @부터 javadoc 주석의 태그.

기본적으로 생성된 출력에는 API 버전을 나열하는 섹션이 포함되어 있습니다.
이 태그가 있을 때 문제의 패키지, 클래스 또는 클래스 멤버가 존재하기 때문입니다.
마주쳤다. 이 정보를 생략하려면 이 옵션을 지정하십시오.

-노트리
트리 페이지를 생성하지 마십시오.

기본적으로 생성된 출력에는 패키지당 하나의 상속 트리가 포함됩니다.
문서 세트는 여러 패키지로 구성됩니다 - 전체 상속이 포함된 페이지
나무. 해당 페이지 생성을 생략하려면 이 옵션을 지정하십시오.

-NOINDEX
알파벳순 인덱스를 출력하지 않습니다.

기본적으로 gjdoc는 모든 프로그램 요소의 알파벳순 인덱스를 생성합니다.
문서 세트(패키지, 클래스, 내부 클래스, 생성자, 메소드 및
필드). 이 정보를 생략하려면 이 옵션을 지정하십시오.

-도움말 없음
도움말 페이지를 생성하지 마세요.

표준 Doclet은 도움말 페이지를 제공하지 않으므로 이 옵션은 현재 무시됩니다.

-nodeprecated
더 이상 사용되지 않는 패키지, 클래스 또는 클래스 멤버에 대한 인라인 정보를 출력하지 마십시오.

기본적으로 표준 Doclet은 더 이상 사용되지 않는 강조 표시된 단락을 추가합니다.
더 이상 사용되지 않는 각 프로그램 요소에 대한 설명에 대한 정보입니다. 이것을 지정하십시오
이 정보를 생략하는 옵션입니다.

-노드 사용 목록
더 이상 사용되지 않는 API 요소에 대한 요약 페이지를 출력하지 마세요.

기본적으로 표준 Doclet은 더 이상 사용되지 않는 모든 API 요소를 나열하는 페이지를 생성합니다.
일반적으로 지원 중단 이유가 포함된 지원 중단 설명과 함께
그리고 가능한 대안. 이 정보를 생략하려면 이 옵션을 지정하십시오.

-nonavbar
탐색 표시줄, 머리글, 바닥글을 출력하지 않습니다.

기본적으로 각 출력 페이지에는 상단 탐색 모음(다음을 포함할 수 있음)이 있습니다.
사용자 지정 헤더) 및 하단 탐색 모음(사용자 지정 헤더를 포함할 수 있음)
지정된 바닥글). 이 장식을 생략하려면 이 옵션을 지정하십시오.

-코멘트 없음
생성된 파일에서 모든 문서 텍스트를 생략하고 선언만 출력합니다.
프로그램 요소 관계.

이 옵션은 다음과의 호환성을 위해 제공됩니다. 자바독. 추출할 계획이라면
귀하의 프로젝트에 대한 정보를 통해 gjdoc, 다른 Doclet 사용을 고려해야 합니다.
대신 XmlDoclet과 같은 목적으로 사용하세요. Doclet API를 사용할 수도 있습니다.
새로운 Doclet을 구현하여 직접적으로.

-링크 소스
각 클래스에 대해 구문 강조 소스 코드가 포함된 페이지를 생성합니다. 기본적으로 이
페이지가 생성되지 않습니다.

소스 코드는 "소스"라고 표시된 버튼을 클릭하여 액세스할 수 있습니다.
탐색 모음을 클릭하거나 생성자, 필드, 메소드 또는 내부 이름을 클릭하여
클래스 문서 페이지의 세부정보 섹션에 있는 클래스입니다.

-사용하다
상호 참조 정보가 포함된 페이지를 생성합니다. 기본적으로 이 페이지는
생성.

상호 참조 정보는 표시된 버튼을 클릭하여 액세스할 수 있습니다.
탐색 표시줄에서 '사용'을 선택하세요.

'사용' 페이지에는 문서 세트에 있는 모든 클래스/인터페이스가 나열되어 있습니다.
문제의 클래스(유형)를 확장/구현합니다. 유형의 필드; 방법이나
해당 유형의 매개변수를 허용하는 생성자 유형을 반환하는 메소드; 그리고
유형을 던지는 메소드 또는 생성자.

-작가
출력에 작성자 정보를 포함합니다.

지정된 경우 작성자 정보는 다음을 사용하여 지정됩니다. @작가 javadoc의 태그
주석이 출력에 통합됩니다. 기본적으로, @작가 태그는 무시됩니다.

-번역
출력에 버전 정보를 포함합니다.

지정된 경우 버전 정보는 다음을 사용하여 지정됩니다. @버전 javadoc의 태그
주석이 출력에 통합됩니다. 기본적으로, @버전 태그는 무시됩니다.

-라이센스 텍스트
각 소스 파일의 첫 번째 주석에 라이센스 텍스트가 포함되어 있다고 가정하고 다음을 추가하십시오.
생성된 각 수업 페이지의 바닥글에 라이선스 정보를 추가합니다.

이는 특정 옵션입니다. gjdoc Sun과 호환되지 않음 자바독.

이 옵션은 소스 코드가 있는 무료 오픈 소스 프로젝트에 사용하기 위한 것입니다.
법적인 이유가 있는 경우 일반적으로 상용구 라이선스 주석이 앞에 붙습니다.
문서에 라이센스를 포함시키기 위한 것입니다.

-docfiles하위 디렉터리
모든 파일을 재귀적으로 복사합니다. 문서 파일 각 패키지 디렉터리의 하위 디렉터리입니다.

일반적으로 다음 폴더에 있는 파일만 문서 파일 하위 디렉토리는 내림차순으로 복사되지 않습니다.
재귀 적으로.

-excludedocfiles하위 디렉터리 name:name: ...
일부 디렉터리를 바로 아래에 복사하지 마십시오. 문서 파일 하위 디렉터리
재귀적으로 하강합니다.

이 옵션에 대한 인수는 콜론으로 구분된 디렉터리 이름 목록이어야 합니다.

이 옵션은 다음 경우에만 의미가 있습니다. -docfiles하위 디렉터리 도 지정됩니다. 이 경우, 어떤
바로 아래에 위치한 하위 디렉토리 문서 파일 디렉토리가 나열되면 생략됩니다.

관습 문서 태그

-taglet경로 경로 목록
검색 경로 목록 다음을 사용하여 지정된 후속 Taglet 클래스를 로드할 때 -태그렛.

경로 목록 디렉토리 또는 jar 파일에 대한 하나 이상의 경로여야 하며,
플랫폼의 경로 구분 기호(일반적으로 : or ;).

-태그렛 클래스 이름
Taglet을 등록합니다.

클래스 이름 구현하는 Java 클래스의 정규화된 이름이어야 합니다.
com.sun.tools.doclets.Taglet.

Taglet 클래스는 다음을 사용하여 지정된 클래스 경로에서 로드됩니다. -taglet경로에서
다음을 사용하여 지정된 클래스 경로 -클래스 경로 그리고 기본 클래스 경로에서.

의 문서를 참조하십시오. com.sun.tools.doclets.Taglet 자세한 내용은.

간단한 태그의 경우 -꼬리표.

-꼬리표 태그 사양
일반 Taglet을 등록합니다.

형식 태그 사양 해야합니다 : :" ".

태그 이름 앞에 @ 기호 없이 일치시킬 태그 이름입니다.

플래그 다음 문자 중 하나 이상입니다. 여기서 각 문자는
태그가 인식되는 소스 코드 컨텍스트입니다.

a 모든 컨텍스트

c 생성자

f 분야

m 방법

o 개요

p 패키지

t 유형(클래스, 인터페이스, 예외, 오류)

X 일시적으로 Taglet을 완전히 비활성화하는 특수 문자입니다.

태그헤드 태그에 해당하는 섹션의 헤더에 표시할 문자열입니다.
문제.

예를 들어 태그 일치를 정의하려면 @cvsid 개괄적으로 받아들여질 것입니다.
패키지 및 유형 페이지이며 헤더로 레이블이 지정됩니다. CVS ID, 당신은
지정:

-tag cvsid:tpo:"CVS ID"

클래스 javadoc 주석에 다음이 포함되어 있다고 가정해 보겠습니다.

@cvsid $Id: cp-tools.texinfo,v 1.9 2012-03-07 15:27:27 gnu_andrew Exp $

그러면 HTML 출력에는 다음과 같은 내용이 포함됩니다.

CVS ID:
$Id: cp-tools.texinfo,v 1.9 2012-03-07 15:27:27 gnu_andrew Exp $

달리는 기타 Doclet

-doclet경로 경로 목록
검색 경로 목록 다음을 사용하여 지정된 Doclet에 대한 클래스를 로드할 때 -도클렛.

경로 목록 디렉토리 또는 jar 파일에 대한 하나 이상의 경로여야 하며,
플랫폼의 경로 구분 기호(일반적으로 : or ;).

-도클렛 className
표준 HtmlDoclet 대신 지정된 Doclet을 실행합니다.

className 공개 기본값이 있는 클래스의 정규화된 이름이어야 합니다.
생성자이며 다음 시그니처가 있는 메서드를 포함합니다.

import com.sun.javadoc.RootDoc;
공개 정적 부울 시작(RootDoc ​​rootDoc)

Doclet 클래스는 다음을 사용하여 지정된 클래스 경로에서 로드됩니다. -doclet경로에서
다음을 사용하여 지정된 클래스 경로 -클래스 경로 그리고 기본 클래스 경로에서.

XNUMXD덴탈의 스타트 메소드는 다음을 통해 Doclet API에 의해 노출된 정보를 처리해야 합니다. 루트닥
반환 참된 성공에, 그릇된 실패시.

타사 Doclet을 사용하는 경우 자세한 내용은 해당 설명서를 참조하세요.
지침. 타사 Doclet에 대한 지원은 실험적입니다. 제발
발생한 문제를 보고하거나 성공적으로 실행되었을 때 피드백을 제공하세요.
타사 애플릿.

이 옵션은 여러 번 지정할 수 있으며, 이 경우 모든 Doclet이 실행됩니다.
각 Doclet 실행에 대해 Doclet API를 통해 동일한 정보 트리가 노출됩니다.

첨가 정보 에 전에, 산출

-창제목 본문
본문 브라우저 창 제목 접두사로 사용됩니다.

지정되면 각 페이지의 브라우저 창 제목 앞에 다음이 붙습니다. 본문
기본 문자열 대신 생성 API 문서.

본문 일반 텍스트여야 합니다(HTML 태그를 포함할 수 없음).

-문서 제목 본문
개요 페이지의 헤더 텍스트를 다음으로 설정합니다. 본문.

본문 짧은 일반 텍스트 문자열이어야 합니다.

단일 패키지에 대한 문서를 생성할 때 이 옵션을 지정하면
개요 페이지 생성.

-헤더 HTML텍스트
추가 HTML텍스트 생성된 모든 페이지의 오른쪽 상단에 있습니다. HTML텍스트 일반적으로
문서화되는 프로젝트의 이름으로 설정됩니다.

-보행인 HTML텍스트
추가 HTML텍스트 생성된 모든 페이지의 오른쪽 하단에 있습니다. HTML텍스트 자주
와 같은 값으로 설정 -헤더.

-맨 아래 HTML텍스트
추가 HTML텍스트 전체 너비에 걸쳐 생성된 모든 페이지의 맨 아래까지
그 페이지. 지정되면, HTML텍스트 일반적으로 저작권 표시 및/또는
다른 프로젝트 페이지에 대한 링크.

-스타일시트 추가 파일
사용자가 지정한 스타일시트로 기본 CSS 스타일 시트를 보강합니다. 파일.

지정된 스타일시트는 기본 스타일에 추가하여 각 HTML 페이지에서 간단히 로드됩니다.
마지막 스타일시트로 사용됩니다.

CSS 계단식 규칙이 적용됩니다. 즉, 스타일 속성은
다음보다 계단식 순서가 높은 경우 할당됩니다. gjdoc의 기본 스타일입니다. 하나의 간단한
이를 확인하는 방법은 재정의를 선언하는 것입니다. ! 중요.

보다http://www.w3.org/TR/REC-CSS2/cascade.html#계단식 순서>.

-그룹 표제 pkg와일드카드:pkg와일드카드: ...
개요 페이지에서 지정된 패키지를 별도의 그룹으로 정렬합니다.

첫 번째 인수는 제목으로 사용되는 짧은 일반 텍스트여야 합니다.
패키지 그룹. 두 번째 인수는 콜론으로 구분된 패키지 목록이어야 합니다.
와일드카드. 그룹은 이름이 다음과 같은 문서 세트의 모든 패키지로 구성됩니다.
주어진 와일드카드 중 하나와 일치합니다.

와일드카드 문자는 하나만 있습니다. *, 패키지 이름의 두 문자와 모두 일치합니다.
구성 요소 및 . 패키지 이름 구성 요소를 분리합니다. 예를 들어, j*정규식 겠지
매치 패키지 java.util.regex. 더 유용한 예는 다음과 같습니다. javax.스윙* 일치하는
javax.swing 그리고 모든 하위 패키지.

이 옵션은 여러 번 제공될 수 있습니다.

FIXME: 그룹 중첩에 대한 정보는 여기에 있습니다.

gjdoc -group "핵심 클래스" 'java*' \
-그룹 "스윙" 'javax.swing*' \
-그룹 "XML API" 'javax.xml*' \
-group "기타 확장" javax* \
...

-개요 파일
다음에서 XHTML 본문 조각을 추가합니다. 파일 개요 페이지로 이동합니다.

파일 HTML이 포함된 XHTML 조각을 포함해야 합니다. 몸 루트 노드로 태그를 지정합니다.

이 옵션은 문서 세트 전체에 대한 설명을 제공하는 데 사용할 수 있습니다.

지정되면 조각의 첫 번째 문장이 테이블 위에 배치됩니다.
조각의 전체 복사본에 대한 링크와 함께 문서화된 패키지 나열
테이블 아래에 놓인 것입니다.

단일 패키지에 대한 문서를 생성할 때 이 옵션을 지정하면
개요 페이지 생성.

-스타일시트파일 파일
CSS 스타일시트를 사용하세요. 파일 기본 CSS 스타일시트 대신.

기본 스타일시트의 일부만 재정의하려면 다음을 사용하세요. -스타일시트 추가
대신.

-제목 본문
더 이상 사용되지 않습니다. -문서 제목 본문 대신.

-도움말 파일 파일
이 옵션은 현재 무시됩니다.

구현되면 XHTML 조각을 사용합니다. 파일 도움말 페이지 내용
기본 도움말 텍스트 대신.

제어 전에, 산출.

-d 예배 규칙서
모든 출력 파일을 예배 규칙서 (및 하위 디렉토리). 예배 규칙서 만들어 질 것이다
존재하지 않는 모든 상위 디렉토리와 필요한 모든 디렉토리를 포함하여 존재하지 않는 경우
하위 디렉토리.

지정하지 않으면 출력이 현재 디렉터리에 배치됩니다.

-장소 name
로케일 사용 name 모든 목적에 대해 기본 로케일 대신.

name 다음 형식의 로케일 지정자여야 합니다. ll_CC[_VAR] 어디에 ll 소문자 XNUMX입니다.
문자 ISO-639 언어 코드, CC 선택적 대문자 3166글자 ISO-XNUMX 국가입니다.
코드 및 VAR 선택적 변형 코드입니다. 예를 들어, en 영어를 지정하고, ko 페이지
미국 영어를 지정합니다. en_US_WIN 미국 영어의 변형된 변형을 지정합니다.
장소.

이 옵션의 의미는 생성자의 의미와 정확히 일치합니다.
수업의 java.util.Locale.

이 옵션은 현재 출력 정렬에 사용되는 Collator만 결정합니다.
강요. 이는 로캘이 비-언어를 사용할 때만 영향을 미친다는 것을 의미합니다.
식별자의 ASCII 문자.

-문자 집합 문자셋
더 이상 사용되지 않습니다. 출력 XHTML 파일의 지정된 인코딩을 지정된 인코딩으로 재정의합니다.
by 문자셋.

이 옵션이 제공되지 않으면 출력 XHTML의 인코딩 사양이 선택됩니다.
파일을 쓸 때 사용된 인코딩(다음과 같이 제공된 인코딩)과 일치합니다. -도센코딩,
또는 플랫폼의 기본 인코딩).

에 대한 의미론 문자셋 여기에 지정됩니다.
<http://www.w3.org/TR/2000/REC-xml-20001006#NT-EncName>. 모든 실용적인 목적을 위해,
charset 매개변수를 허용하는 다른 옵션과 동일합니다.

이 옵션은 다음과의 호환성을 위해 제공됩니다. 자바독 피해야합니다.

-도센코딩 문자셋
출력 파일을 작성할 때 플랫폼 대신 지정된 문자 세트 인코딩을 사용하십시오.
기본 인코딩.

예 문자셋 are US-ASCII, ISO-8859-1 or UTF-8.

이 옵션의 의미는 클래스 생성자의 의미와 정확히 일치합니다.
java.util.Locale.

-유효한 HTML
유효한 XHTML 코드를 강제로 생성합니다. 이는 기존 방식과의 호환성을 깨뜨립니다.
어느 정도 Javadoc 도구.

이 옵션을 지정하면 앵커 이름이 유효하도록 수정됩니다.
XHTML 1.1 사양을 따릅니다. 그러나 다음으로 생성된 문서 세트는
이 옵션은 기존 Javadoc 도구를 사용하여 제대로 연결할 수 없습니다. 그것은 할 수 있다
하지만 Gjdoc을 사용하면 문제 없이 연결될 수 있습니다.

이 옵션이 없으면 실행 가능한 클래스 멤버의 앵커 이름은 기존 방식을 사용합니다.
형식(예: "foo(String,int[])"). 이는 기존 방식과 호환됩니다.
Javadoc 도구이지만 HTML 4.0과 XHTML 1.0 및 1.1 사양을 모두 따릅니다.
이 형식에는 잘못된 문자가 포함되어 있습니다. 괄호, 대괄호 및 쉼표
앵커 이름에는 허용되지 않습니다.

-baseurl URL
다음을 기준으로 페이지 URL을 하드와이어합니다. URL 생성된 각 페이지에

특정 회사에서만 사용할 수 있는 문서를 생성하는 경우
URL을 지정하려면 이 옵션을 사용해야 합니다.

이는 스패머가 사용하는 특정 리디렉션 공격을 방지하는 데 도움이 될 수 있으며 도움이 될 수 있습니다.
특정 웹 클라이언트의 경우.

다변 옵션

-조용한
경고 및 오류 메시지를 제외한 모든 출력을 억제합니다.

-말 수가 많은
무엇에 대해 매우 장황하게 설명하십시오. gjdoc 하고있다.

이 옵션은 현재 무시됩니다.

온라인 머신 옵션

태양의 자바독 도구는 다음을 기반으로 하는 것 같습니다. javac 따라서 VM에서 작동하는 것 같습니다.
수평. gjdoc반면에 는 순수한 Java 애플리케이션입니다.

따라서, gjdoc 다음 VM 수준 옵션만 가짜로 만들거나 시뮬레이션할 수 있습니다.

-클래스 경로 경로 목록
가상 머신 설정 클래스 경로 에 경로 목록.

대부분의 경우 다음을 사용해야 합니다. -doclet경로 or -taglet경로 이 옵션 대신.

경로 목록 디렉토리 또는 jar 파일에 대한 하나 이상의 경로여야 하며,
플랫폼의 경로 구분 기호(일반적으로 : or ;).

이 옵션이 래퍼 수준에서 차단되지 않으면 gjdoc 현재 그것을 가짜로 만들고 있습니다
부름 System.setProperty("java.class.path", 경로 목록); 그리고 경고를 출력합니다.

-부트 클래스 경로 경로 목록
가상 머신 설정 부트클래스 경로 에 경로 목록.

이 옵션이 래퍼 수준에서 차단되지 않으면 gjdoc 경고를 출력합니다.

-Jvmopt
가상 머신에 임의의 매개변수 전달 gjdoc 계속됩니다.

이 옵션이 래퍼 수준에서 차단되지 않으면 gjdoc 흉내내려고 노력한다
옵션을 선택하고 경고를 출력합니다.

현재는 VM 옵션만 -D 시스템 속성 설정이 에뮬레이트됩니다.

onworks.net 서비스를 사용하여 온라인으로 gjdoc-4.8 사용