Javadoc 1.4. 2 의 신기능 - xrath.com 에서 번역됨

# Javadoc 1.4. 2 의 신기능

Javadoc 툴

이 문서에서는, 버젼 1.4. 1 에서 1.4. 2 에의 이행으로 Javadoc 툴에 대해서 행해진 변경에 대해 설명합니다.

게재되고 있는 변경점에는, 버그 번호와 그 수정이 Javadoc 툴의 프론트엔드에 대하는 것 ( 「툴」)인지, 또는 표준 도크 렛에 대하는 것 ( 「표준 도크 렛」)일지가 나타나고 있습니다. 「리그렛션」이라고 하는 용어는, 1.3.x 에서는 동작하고 있었는데, 1.4. 0 또는 1.4. 1으로 동작하지 않게 되어, 1.4. 2 로 수정된 기능에 대해서 사용됩니다.

- 주요한 신기능
- 주요한 버그 수정
- 주요한 기존의 버그
- 신기능과 버그 수정
  - 커멘드행 옵션
  - 태그
  - 올바르지 않은 API 스펙
  - HTML 와 Javascript
  - 무효인 HTML
  - 링크
  - Javadoc 의 실행
  - 에러 메세지와 경고 메세지
  - Accessibility
  - 도크 렛 API

### 주요한 신기능

- 이 버젼에서는, Acessibility (사용자 보조 기능)에 대한 미국 정부의 제 508 항의 요건에 관련한 버그가 모두 수정되었습니다. (4737558 , 표준 도크 렛)
- 「직렬화 된 형식」에 serialVersionUID 를 짜넣었습니다. (4525039 , 표준 도크 렛)
- 문서화의 대상이 아닌 원시 파일로부터 코멘트를 상속할 수 있게 되었습니다. 문서화하는 코드는, 커멘드행으로 건네받지 않은 원시 파일에서도, -sourcepath 상에 있는 원시 파일이면, 그 원시 파일내의 인터페이스 및 클래스로부터 코멘트를 자동적으로 상속할 수가 있습니다. 예를 들어, J2SE 의 경우에 이 기능을 시험하려면 , SDK 에 동고 되고 있는 src.zip (다만, 원시 파일의 일부 밖에 포함되지 않았다)를 해동해, 그 패스를 -sourcepath 에 추가합니다. 목적의 코드에 대해서 javadoc 를 실행하면(자), 필요에 따라서 이러한 원시 파일로부터 다큐멘테이션 코멘트가 로드 됩니다. 코드가 java.lang.Comparable 를 구현하고 있는 경우는, 구현한 `compareTo(Object)` 메소드는 java.lang.Comparable 로부터 다큐멘테이션 코멘트를 상속합니다. 이 기능은, 실제로는 1.4. 1 으로 사용 가능하게 되었습니다.
- (버그 번호 이루어, 툴) `-link` (또는 `-linkoffline`) 옵션을 사용했을 때, 모든 `@see` 태그 및 `{@link}` 태그에 의해, 제외된 클래스에의 링크도 작성되게 되었습니다. 이 수정은, 외부의 클래스 및 멤버를 링크하는 작업을 큰폭으로 간략화합니다. 이전에는,`@see` 또는 `{@link}` 로 외부 클래스의 문서에 링크하기 위해서는, 그 외부 클래스를 임포트 하는지, 선언 중(안)에서 완전하게 수식할 필요가 있었습니다. 이번 버젼으로부터는, 클래스를 완전하게 수식한 데다가, 그 클래스의 API 문서가 `-link` 에 의해 지정한 패스상에 존재하는 것만으로 좋게 되었습니다. (4652655 , 표준 도크 렛)

  그 외의 신기능에 대해서는, 아래에 게재합니다.

### 주요한 버그 수정

- 링크:완전 수식된 프로그램 요소의 @link 를 수정해,`-link` 옵션으로 지정된 외부 클래스에 링크하도록(듯이) 했습니다. (4652655 , 툴, 리그렛션)
- 링크:. java 파일이 건네받았을 때, 반환값 및 파라미터의 형태에 대한 내부 링크가 결핍 한다고 하는 버그를 수정했습니다. (4628281 , 툴)
- 실행:중복 한 클래스도 문서화하도록(듯이) 수정했습니다. (4673477 , 툴, 리그렛션)
- 직렬화 된 형식:「직렬화 된 형식」에 있어서의 링크 엥커를 수정했습니다. (4521661 , 표준 도크 렛)
- Javascript:-linkoffline 에 의해 링크되었을 때의 Internet Explorer Javascript 의 로드 에러. (4645058 , 표준 도크 렛, 리그렛션)
- HTML:패키지명을 건네주었을 경우나 . java 파일명을 건네주었을 경우에 diff 가 나오지 않게 수정했습니다. (4506980 , 표준 도크 렛)

  그 외의 버그 수정에 대해서는, 아래에 게재합니다.

### 주요한 기존의 버그

Javadoc 툴이 행업 하는 것이 있는 버그나, 매우 현저한 버그에 대해, 여기서 소개합니다. 또, 미해결의 버그의 간이판 리스트에 대해서는중요한 새로운 버그와 리그렛션의 설명, 데이타베이스의 일람표에 대해서는 Important Bug Fixes and Changes 를 참조해 주세요.

- 코멘트를 상속할 수 없는 멤버중에서 @inheritDoc 를 사용하면(자), 도움이 되는 메세지가 표시되지 않고 Javadoc 가 행업 합니다 (4812240 , 표준 도크 렛). 예를 들어 다음과 같은 경우입니다.

      public class C {
          /** {@inheritDoc} */
          public abstract void m() {
          }
      }

- Internet Explorer 로 프레임을 표시하면(자), 메인 컨텐츠의 페인에 불필요한 수평 스크롤 바가 표시됩니다. 간단한 회피책이, 버그 리포트 중(안)에서 설명되고 있습니다. (4852280 , 표준 도크 렛)

### 신기능과 버그 수정

1.4. 2 에 있어서의 모든 신기능과 버그 수정은 이후에 게재합니다.

커멘드행 옵션

- 신기능: 좌상 프레임에 -packagesheader 옵션을 추가했습니다. (4766385 , 표준 도크 렛)
- 신기능: 「-tag name:a:name」에 대해서 「-tag name」라고 하는 단축 표기가 사용 가능하게 되었습니다. (4695326 , 표준 도크 렛)
- 신기능: 각 탭을 n 개의 공백 문자로 변환하기 위한 -linksourcetab 옵션을 추가했습니다. 이 옵션은 실험적이며, 변경될 가능성이 있습니다. (4510979 , 표준 도크 렛)
- 신기능: -tag 옵션으로, @ejb:bean 등의 xdoclet 태그에 대해서 데쉬 (-) 단락 문자를 사용할 수 있게 되었습니다. (4750173 , 표준 도크 렛)
- 신기능: 새롭다 -keywords 옵션에 의해, API 의 검색을 개선하기 위해서 멤버명을 META 키워드 태그로서 추가할 수 있게 되었습니다. (4764726 , 표준 도크 렛)
- 신기능: 경고가 있었을 경우에 제로 이외로 종료하기 위한 -Xwerror 플래그를 추가했습니다. (4099527 , 툴)
- 버그 수정:옵션 「-tag tagname:X:taghead」를 수정해, taghead 를 생략 가능하게 했습니다. (4628181 , 표준 도크 렛)
- 버그 수정 :-quiet 옵션에 의해 억제되는 것이 표준 도크 렛의 메세지 뿐인 것을 문서에 명기했습니다 (4714350 , 표준 도크 렛). 새로운 버그 4702454 를 제출해, javadoc 툴의 메세지도 억제하도록(듯이) 요구했습니다.
- 버그 수정:이것은, 실제로는, 최초부터 툴의 옵션이었습니다. (4760924 , 표준 도크 렛)

태그

- 신기능: Javadoc 로, 실행시 예외의 @throws 코멘트를 상속하게 되었습니다. (4679573 , 표준 도크 렛)
- 신기능: Javadoc 로, @param 의 최초의 인수가 파라미터명이 아닌 경우에 경고를 내게 되었습니다. (4693440 , 표준 도크 렛)
- 버그 수정 :@throws 의 텍스트를 상속할 때, 완전 수식의 예외명을 비교하도록(듯이) 했습니다. (4684827 , 표준 도크 렛)
- 버그 수정:자동 생성의 예외만이 후에 계속되는 경우에 「예외」표제가 결핍 한다고 하는 버그를 수정했습니다. (4530727 , 표준 도크 렛)
- 버그 수정 :abstract 슈퍼 클래스의 인터페이스로부터 상속할 때에 망가져 있던 @inheritDoc 를 수정했습니다. (4720974 , 표준 도크 렛)

API 스펙

- 신기능: 「직렬화 된 형식」에 serialVersionUID 를 짜넣었습니다. (4525039 , 표준 도크 렛)
- 신기능: 문서화의 대상이 아닌 원시 파일로부터 코멘트를 상속할 수 있게 되었습니다. 문서화하는 코드는, 커멘드행으로 건네받지 않은 원시 파일에서도, -sourcepath 상에 있는 원시 파일이면, 그 원시 파일내의 인터페이스 및 클래스로부터 코멘트를 자동적으로 상속할 수가 있습니다. 예를 참조해 주세요. (버그 번호 이루어, 툴)
- 버그 수정:개요 테이블로, 상속된 상자의 클래스가 결핍 하고 있다고 하는 버그를 수정했습니다. (4638588 , 표준 도크 렛)
- 버그 수정 :Javadoc 가 숨겨진 필드를 잘못해 리스트에 포함하지 않게 수정했습니다. (4492178 , 표준 도크 렛)
- 버그 수정 :public 이외의 직렬화 가능 클래스의 직렬화 가능한 슈퍼 클래스를 추가하도록(듯이) 했습니다. (4671694 , 표준 도크 렛)
- 버그 수정 :private 메소드 (예를 들어 createBufferStrategy)의 오버라이드(override)를 문서화하지 않게 했습니다. (4634891 , 표준 도크 렛)

HTML 와 Javascript

- 신기능: 생성되는 HTML 코멘트에, javadoc 의 버젼 번호와 빌드를 짜넣도록(듯이) 했습니다. (4749707 , 표준 도크 렛)
- 버그 수정:「직렬화 된 형식」페이지의 클래스를 참조하는 링크에 「#anchor」를 추가하도록(듯이) 되돌렸습니다. (4521661 , 표준 도크 렛, 리그렛션)
- 버그 수정 :-linkoffline 에 의해 링크되었을 때의 Javascript IE 로드 에러를 수정했습니다. (4645058 , 표준 도크 렛, 리그렛션)
- 버그 수정:패키지명을 건네주었을 경우나 . java 파일명을 건네주었을 경우에 diff 가 나오지 않게 수정했습니다. (4506980 , 표준 도크 렛)
- 버그 수정:무효인 stylesheet.css 파일 (font-size: normal)을 수정했습니다. (4417174 , 표준 도크 렛)
- 버그 수정:왼쪽 프레임을 로드했을 때에 윈도우 타이틀이 변화하지 않게 수정했습니다 (Javascript, 표준 도크 렛). (4747738 , 표준 도크 렛)

무효인 HTML

- 버그 수정 :DOCTYPE 선언으로 결핍 하고 있던 공백 문자를 추가했습니다. (4625400 , 표준 도크 렛)
- 버그 수정:프레임 세트 DTD 내의 무효인 HTML 와 여분의 <DL> 를 수정했습니다. (4275630 , 표준 도크 렛)
- 버그 수정 :<FRAMESET> 요소의 외측에서는 사용할 수 없는 <NOFRAMES> 를 수정했습니다. (4753048 , 표준 도크 렛)
- 버그 수정 :index-all.html 파일내가 잘못했다 ! DOCTYPE 를 수정했습니다. (4418115 , 표준 도크 렛)
- 버그 수정:「패키지의 사용」페이지로 잘못한 장소에 삽입되고 있던 HTML 테이블 태그를 수정했습니다. (4415270 , 표준 도크 렛)

링크

- 버그 수정:. java 파일이 건네받았을 때, 반환값 및 파라미터의 형태로 내부 링크가 결핍 한다고 하는 버그. (4628281 , 툴, 리그렛션)
- 버그 수정:완전 수식된 프로그램 요소의 @link 를 수정해,`-link` 옵션으로 지정된 외부 클래스에 링크하도록(듯이) 했습니다. (4652655 , 툴, 리그렛션)
- 버그 수정 :-link 및 -linkoffline 를 수정해, 적절한 상대 링크를 생성하도록(듯이) 했습니다. (4720957 , 표준 도크 렛)
- 버그 수정 :Windows 상에서 실행했을 때, -linksource 옵션에 의해 링크안에 「\」이 생성되지 않게 했습니다. (4511110 , 표준 도크 렛)
- 버그 수정:{@link java.lang label} 내의 라벨이, 패키지명에 링크하고 있을 때도 무시되지 않게 했습니다. (4524136 , 표준 도크 렛)
- 버그 수정 :@link 태그로, 제 1 인수와 제 2 인수의 사이에 개행만이 존재할 경우에 적절하지 않은 서식을 설정하지 않게 수정했습니다. (4739870 , 표준 도크 렛)

Javadoc 의 실행

- 버그 수정:소스 디렉토리에 이름이 없는 패키지의 테스트 파일이 포함되어 있는 경우에, 툴이 크래쉬 하지 않게 했습니다. (4670772 , 툴)
- 버그 수정:중복 한 클래스를 재차 문서화하도록(듯이) 수정했습니다. (4673477 , 툴, 리그렛션)
- 버그 수정:빈 상태(empty)의 jar 파일이 classpath 상에 있는 경우에, 빈 상태(empty)의 jar 파일이 classpath 에 있어도 예외를 throw 하지 않게 수정했습니다. (4697113 , 표준 도크 렛)
- 버그 수정:파일:소스 디렉토리와 생성처 디렉토리가 같은 경우에서도, doc-files 가 파괴되지 않게 되었습니다. (4258405 , 표준 도크 렛)

에러 메세지와 경고 메세지

- 버그 수정:의미의 이해하기 어려운 「foo.jar:Body tag missing from HTML」라고 하는 에러 메세지를 개선했습니다. (4691095 , 표준 도크 렛)
- 버그 수정 :Javadoc 를 수정해, classpath 의 jar 파일에 package.html 파일이 포함되어 있어도 에러를 보고하지 않게 했습니다. (4697040 , 표준 도크 렛)
- 버그 수정:「Parameter foo is documented more than once.」라고 하는 부정한 경고를 수정했습니다. (4745855 , 표준 도크 렛)
- 버그 수정 :System.out 나 System.err 는 아니고, Messager PrintWriters 를 사용하게 되었습니다. (4644257 , 표준 도크 렛)

Accessibility

- 버그 수정:「인터페이스」로서의 이탤릭 스타일에 대해 설명하는 타이틀 기술을 링크에 추가했습니다. (4714257 , 표준 도크 렛)
- 버그 수정:사용자 보조 기능으로서 네비게이션 바를 스킵 하는 기능을 추가했습니다. (4638136 , 표준 도크 렛)
- 버그 수정:사용자 보조 기능으로서 테이블에 summary 속성을 추가했습니다. (4637604 ,4775148 , 표준 도크 렛)
- 버그 수정:사용자 보조 기능으로서 <FRAME> 태그에 title 속성을 추가했습니다. (4636655 , 표준 도크 렛)
- 버그 수정:<H1>, <H2>, <H3> 가 적절한 순서가 되도록(듯이) 수정했습니다. (4636667 , 표준 도크 렛)
- 버그 수정:사용자 보조 기능으로서 클래스 계층도의 ASCII 아트에 동등의 내용의 텍스트를 추가했습니다. (4706779 , 표준 도크 렛)

도크 렛 API

- 신기능: Doclet API 를 확장해, Tag 인터페이스에 holder() 메소드를 추가했습니다. (4706525 , 표준 도크 렛)
- 버그 수정 :Doc 객체가 다시,== 그리고 비교 가능하게 되었습니다. (4731054 , 툴, 리그렛션)
- 버그 수정:. class 파일로부터 빌드 했을 때, 상자의 클래스의 ClassDoc 가 잘못되어 있던 것을 수정했습니다. (4694497 , 툴)
- 버그 수정 :Doc.position()의 스펙을 명확하게 했습니다. (4748246 , 표준 도크 렛)
- 버그 수정 :RootDoc 의 classes() 메소드의 스펙을 명확하게 했습니다. (4748234 , 표준 도크 렛)
- 버그 수정 :com.sun.javadoc.SeeTag 의 스펙을 명확하게 했습니다. (4754029 , 표준 도크 렛)
- 버그 수정 :PackageDoc.ordinaryClasses()의 스펙을 명확하게 했습니다. (4748244 , 표준 도크 렛)
- 버그 수정 :com.sun.javadoc.Doc 의 스펙에 있는 「kind」의 의미를 명확하게 했습니다. (4502589 , 표준 도크 렛)
- 버그 수정 :Doc.isClass()의 스펙과 모든 「class (클래스)」라고 하는 용어의 의미를 명확하게 했습니다. (4748245 , 표준 도크 렛)
- 버그 수정:「class (클래스)」의 의미를 한층 더 명확하게 했습니다. (4763596 , 표준 도크 렛)
- 버그 수정 :PackageDoc.allClasses() 메소드의 스펙과 「included」라고 하는 용어의 의미를 명확하게 했습니다. (4748240 , 표준 도크 렛)
- 버그 수정 :ProgramElementDoc.qualifiedName()의 파라미터 리스트의 스펙을 명확하게 했습니다. (4621267 , 표준 도크 렛)
- 버그 수정 :RootDoc.classes() 및 PackageDoc.allClasses()의 스펙을 명확하게 했습니다. (4748238 , 표준 도크 렛)

Copyright © 2003 Sun Microsystems, Inc. All Rights Reserved. | Java Software