You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ofbiz.apache.org by jl...@apache.org on 2021/11/16 11:13:30 UTC

[ofbiz-site] branch master updated: Improved: entity element descriptions (OFBIZ-12383)

This is an automated email from the ASF dual-hosted git repository.

jleroux pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ofbiz-site.git


The following commit(s) were added to refs/heads/master by this push:
     new bd9373c  Improved: entity element descriptions (OFBIZ-12383)
bd9373c is described below

commit bd9373cc7b2761091a5d98b5aa999889978c6321
Author: Jacques Le Roux <ja...@les7arts.com>
AuthorDate: Tue Nov 16 12:13:31 2021 +0100

    Improved: entity element descriptions (OFBIZ-12383)
    
    added:
    entitymodel.xsd: desriptions for
    
    table-name
    default-resource-name
    dependent-on
    
    Thanks Pierre Smits
---
 dtds/entitymodel.xsd | 25 ++++++++++++++++++++++---
 1 file changed, 22 insertions(+), 3 deletions(-)

diff --git a/dtds/entitymodel.xsd b/dtds/entitymodel.xsd
index 9faeed6..55c6eb4 100644
--- a/dtds/entitymodel.xsd
+++ b/dtds/entitymodel.xsd
@@ -79,10 +79,29 @@ under the License.
     <!-- see the children of entitymodel section for description, etc. -->
     <xs:attributeGroup name="attlist.entity">
         <xs:attribute name="entity-name" type="xs:string" use="required"/>
-        <xs:attribute name="table-name" type="xs:string"/>
+        <xs:attribute name="table-name" type="xs:string">
+            <xs:annotation>
+                <xs:documentation>
+                    The name of the table in the underlying rdbms
+                </xs:documentation>
+            </xs:annotation>
+        </xs:attribute>
         <xs:attribute name="package-name" type="xs:string" use="required"/>
-        <xs:attribute name="default-resource-name" type="xs:string"/>
-        <xs:attribute name="dependent-on" type="xs:string"/>
+        <xs:attribute name="default-resource-name" type="xs:string">
+            <xs:annotation>
+                <xs:documentation>
+                    Association to a particular resource. Currently only an association with an EntityLabel.xml files is supported.
+                </xs:documentation>
+            </xs:annotation>
+        </xs:attribute>
+        <xs:attribute name="dependent-on" type="xs:string">
+            <xs:annotation>
+                <xs:documentation>
+                    Establishes the sub/super class structure of the entity. 
+                    The entity (sub class) takes elements from the entity on which it depends (super class).
+                </xs:documentation>
+            </xs:annotation>
+        </xs:attribute>
         <xs:attribute name="sequence-bank-size" type="xs:string">
             <xs:annotation>
                 <xs:documentation>