Re: documenting GenerationGap-based classes

Generally I use an eogenerator template that supports javadoc entries  
in the userinfo dictionary. It's a pain to edit in EOModeler's  
inspector, but it works. e.g., something like this:

     /**
           <$if Relationship.userInfo.javadoc$>< 
$Relationship.userInfo.javadoc$>
           <$endif$>
           @param value the value to set
           @see #<$Relationship.name$>()
       */
     public void set<$Relationship.name.initialCapitalString$>(< 
$Relationship.destinationEntity.referenceJavaClassName$> value) {


On Mar 24, 2006, at 12:37 PM, Zak Burke wrote:

> This is a design patterns question rather than a WO question, but I  
> figure a lot of WO folks use eogenerator/Generation Gap to manager  
> their EOs so this would be a good place to ask.
>
> How do you manage documentation for EO classes based on Generation  
> Gap?
> Javadoc comments are required to be immediately adjacent to the  
> methods they modify. By using Generation Gap, however, most of  
> these methods only exist on the superclass and the only class you  
> ever edit is the derived class.
>
> So ... where do you / how do you document your EO attributes and  
> relationships?


-- 
WireHose: Smart metadata and personalization for WebObjects.
http://www.wirehose.com/