myfaces-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Simon Kitching (JIRA)" <...@myfaces.apache.org>
Subject [jira] Created: (MYFACES-782) Documentation for UIData
Date Fri, 04 Nov 2005 02:50:54 GMT
Documentation for UIData
------------------------

         Key: MYFACES-782
         URL: http://issues.apache.org/jira/browse/MYFACES-782
     Project: MyFaces
        Type: Improvement
    Reporter: Simon Kitching
    Priority: Minor


Understanding how the UIData table management works in JSF has taken me quite a lot of time.

I think it would be nice for future developers to have some guidance on how this non-trivial
code works.

Attached is a patch to provide at least a start for others learning this code. Ideally I think
this could be put into the UIData class javadoc.
The description is deliberately phrased in a way that will be stable; unless the "flyweight"
approach is ditched this description will
continue to be valid. This info is also useful to people working on components that have to
live *in* a table. This is clearly a difficult
topic, as seen by the number of recent patches to make Tomahawk components work correctly
in tables.

Alternatives would be to put it into that class as an ordinary comment (non-javadoc), or to
put it onto a wiki or similar, with a reference
in the javadoc to that wiki page. However without something in the sourcefile itself I don't
think many developers will be able to find the 
information at the appropriate time,

Thanks,  Simon

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


Mime
View raw message