forrest-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Diana Shannon <shan...@apache.org>
Subject Re: Forrest is overdocumented
Date Wed, 13 Nov 2002 12:29:28 GMT

On Tuesday, November 12, 2002, at 10:25  AM, Andrew C. Oliver wrote:

> Compilable dependency resolution.  I'll leave the XML->XML version of 
> this to the geniuses but for the java version any contract mentioned in 
> the documentation should have an <element-dependancy 
> classname="org.apache.poi.hssf.usermodel.HSSFCell" 
> method="getFormat(int)"/> and if ever the getFormat(int) method goes 
> away or something the compilation of the XML will fail and I'll be 
> forced to update it.

I fear this approach is a bit oversimplistic, paticularly for projects 
with large amounts of code. Some docs would have dependencies on *many* 
classes. Potential contract violations (revealed during the build 
process??) would overwhelm committers/users.

> Secondly.  Move the documentation as close to the code as possible 
> while making the conceptual documentation depend on it!

Can you elaborate?

Diana


Mime
View raw message