JDK-4777110 : propose @realizes javadoc tag
  • Type: Enhancement
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 1.4.1
  • Priority: P5
  • Status: Closed
  • Resolution: Duplicate
  • OS: solaris_9
  • CPU: sparc
  • Submitted: 2002-11-11
  • Updated: 2014-05-05
  • Resolved: 2005-05-26
Related Reports
Duplicate :  
Description

Name: gm110360			Date: 11/11/2002


FULL PRODUCT VERSION :
java version "1.4.1_01"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.4.1_01-b01)
Java HotSpot(TM) Client VM (build 1.4.1_01-b01, mixed mode)


A DESCRIPTION OF THE PROBLEM :
Classes that implement Enterprise Java Beans must also
stylistically implement the business methods declared on
their corresponding EJBObject interfaces. Javadoc should
be able to inherit the documentation for those business
methods from the EJB interface, which the class realizes.

I propose that the @realizes tag be introduced to declare
that a class also implements the methods declared on the
specified interface. Javadoc would then inherit the
documentation and establish hyperlinks the same way as it
now does to interfaces that are implemented by the class.

REPRODUCIBILITY :
This bug can be reproduced always.
(Review ID: 166924) 
======================================================================

Comments
EVALUATION Needs concensus. ###@###.### 2002-12-14 Resolved by 4636466: Java Language Metadata (annotation). Closed as a dupe of that. ###@###.### 2005-05-26 15:58:14 GMT
14-12-2002