[OFBIZ-305] New "description" attribute for entitymodel fields to help keep comments

• Type: Improvement
• Status: Closed
• Priority: Trivial
• Resolution: Duplicate
• Affects Version/s: Trunk
• Component/s: framework
• Assignee: Adam Heath
• Reporter: Marco Risaliti
• Created: 14/Sep/06 20:43
• Updated: 23/Nov/07 06:12
• Resolved: 23/Nov/07 06:12

Description

Copy of http://jira.undersunconsulting.com/browse/OFBIZ-582 from Leon Torres.

=========================================================

Please put in this small change to the entitymodel xsd which will add a "description" attribute to entity fields, to help describe the fields. It'll be nice to keep comments about the data model right there with the definition and will also allow later on for them to be displayed by an entity model viewer such as those in webtools.

All Comments Work Log Change History Sort Order:
Comment by David E. Jones [18/Dec/05 11:26 PM] [ Permlink ]
Rather than using an attribute a sub-element for this is probably better, especially if the description ever gets a bit longer. This is also more consistent with the descrption under the entity and view-entity elements. Now it can be put under just about everything.

This patch still does not include code changes to put these values in the corresponding objects during the parsing, so the code for the following elements needs to be changed (and this issue should perhaps stay open until they are):

field
relation
index
member-entity
alias-all
alias
view-link

The XSD file updates are in SVN rev 6365.

Comment by Chris Howe [07/Jan/06 05:02 AM] [ Permlink ]
Can this issue be closed?

Comment by Si Chen [09/Jan/06 04:08 PM] [ Permlink ]
Actually somebody needs to write some code for getting this field into ModelField/ModelEntity/etc. etc. Want to take a shot at it?

Comment by Marco Risaliti [14/Sep/06 02:12 AM] [ Permlink ]
Can I move it ?

Thanks
Marco

Comment by Marco Risaliti [14/Sep/06 03:02 AM] [ Permlink ]
This patch seems to be not applied so probably no-one need it.
Can I close it ?

Thanks
Marco

Issue Links

• relates to: OFBIZ-1389 Add support for <description> element in entity model classes