http://ofbiz.116.s1.nabble.com/Re-svn-commit-r569568-in-ofbiz-trunk-applications-content-entitydef-entitymodel-xml-src-org-ofbiz-col-tp183309.html
It's great that you're adding comments to the entity definitions to clarify these things.
There is a feature in the entity def XML files to help with this, namely the "description" element that goes under almost any of the elements in that file, including the "field" element.
> Modified: ofbiz/trunk/applications/content/entitydef/entitymodel.xml
> URL:
http://svn.apache.org/viewvc/ofbiz/trunk/applications/content/entitydef/entitymodel.xml?rev=569568&r1=569567&r2=569568&view=diff> ==============================================================================
> --- ofbiz/trunk/applications/content/entitydef/entitymodel.xml (original)
> +++ ofbiz/trunk/applications/content/entitydef/entitymodel.xml Fri Aug 24 16:16:18 2007
> @@ -187,7 +187,7 @@
> title="Content Entity">
> <field name="contentId" type="id-ne"></field>
> <field name="contentTypeId" type="id"></field>
> - <field name="ownerContentId" type="id"></field>
> + <field name="ownerContentId" type="id"></field> <!-- used for permissions checking -->
> <field name="decoratorContentId" type="id"></field>
> <field name="instanceOfContentId" type="id"></field>
> <field name="dataResourceId" type="id"></field>
> @@ -311,8 +311,8 @@
> <entity entity-name="ContentAssoc"
> package-name="org.ofbiz.content.content"
> title="Content Association Entity">
> - <field name="contentId" type="id-ne"></field>
> - <field name="contentIdTo" type="id-ne"></field>
> + <field name="contentId" type="id-ne"></field> <!-- "parent" content -->
> + <field name="contentIdTo" type="id-ne"></field> <!-- "child" or "sub" content -->
> <field name="contentAssocTypeId" type="id"></field>
> <field name="fromDate" type="date-time"></field>
> <field name="thruDate" type="date-time"></field>