Currently, when JavaDoc finds an error (for example, in an
@see link) it reports the error. However, the nature and timing
of the report may or may not meet the needs of the doclet doing
the processing. (DocCheck, for example, would like full control
over the format and placement of the errors.)

Talked it over with Atul, and he agrees that it may make sense
to add a getErrors() method to the RootDoc class, which would
return an array of DocError(?) objects. Or possibly the generic
Doc object should have the getErrors() method, which would
return an array of DocError objects for that entity. Each DocError
object would encapsulate a single error that was identified
when processing that entity. (Clearly, the nature of the API
needs to be given some thought.)

eric.armstrong@eng 1998-08-17