From: Max M. <mm...@pe...> - 2002-05-17 19:08:46
|
All: I just thought that I would give you a quick update on the documentation situation, believe it or not but it is improving day by day. I have made my way JavaDoc'ing through about 1/5 of the code in the ERExtensionsJava framework I estimate. I have been trying to hit the larger/more popular classes first (ERXExtensions, ERXGenericRecord, ERXSession, etc.) before moving on the some of the more obscure components. I have been using the @binding notation to denote the bindings of the component (see ERXTable for a full blown binding list). I have also been adding lots of FIXME, DELETEME, CHECKME, ENHANCEME and MOVEME comments throughout the classes, so there is lots of work to go around for those that are interested. I only ask that if you don't commit very often to the repository that you first start out posting your patches to the list, and also if you don't understand something please ask. I do plan on getting back around to correcting all of the things I have flagged, but only after all of the documentation is done. A few quick questions for the collective: 1) We have a bunch of system property keys sprinkled throughout a number of classes in each framework. What I would like to know is what would be the best way to centralize these property keys to a single spot? I was thinking of adding an abstract inner class called PropertyKey to ERXExtensions where we could put all of the keys and document them. This way we can also insure that we don't have name space conflicts. Also be a good way for people new to the framework to see what property keys they could/need to have set. 2) The @binding works well for bindings, but what should we use for keys that are resolved from the d2wContext? Meaning if I am writing docs for ERD2WEditNumber what should I use to denote that you can set in the rules the key 'formatter'? Maybe @contextkey ? Also what about those crafty components that can either resolve via binding or via d2wContext? 3) I think that for ERDirectToWeb we should also have a centralized ContextKey class (like the above PropertyKey class) so we can know all of the different keys we have added to the d2wContext (also to avoid name space conflicts). One last bit, this is the last day that this email address will work (yeah! last day at Perfect). If you need to get ahold of me off list use Max...@ma.... Also I will be on vacation and unreachable for all of next week (yeah again!). Regards, Max |