JDK-4317026 : PrintWriter documentation error: write() methods don't throw IOException
  • Type: Bug
  • Component: docs
  • Sub-Component: guides
  • Affected Version: 3.1.1,1.3.0
  • Priority: P4
  • Status: Closed
  • Resolution: Duplicate
  • OS: generic,solaris_2.6
  • CPU: generic,sparc
  • Submitted: 2000-02-28
  • Updated: 2000-10-30
  • Resolved: 2000-10-30
Related Reports
Duplicate :  
JDK-4317583 - stddoclet: Inherited @throws improperly copies from overridden method to subclas
Description

Name: rlT66838			Date: 02/28/2000


> java -version
java version "1.3.0rc1"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.3.0rc1-T)
Java HotSpot(TM) Client VM (build 1.3.0rc1-S, interpreted mode)


The PrintWriter class doc in the JDK doc download states that the three
overloaded write() methods:
  write(int c)
  write(char[] buf,int start,int end)
  write(String str,int start,int end)

all throw IOException - but of course they don't.
(Review ID: 101790) 
======================================================================
Comments
EVALUATION Asked naveends for evaluation. alan.sommerer@Eng 2000-02-28 There is currently a bug in the javadoc tool itself (4317583) that causes improper copying of @throws tag from super to sub class spec, and that's what's happening here. Since the cause of the bug is javadoc, and not the source file, I'm closing this as a duplicate of 4317583. When javadoc gets its bug fix, this documentation problem will vanish. scott.hommel@eng 2000-10-30
30-10-2000