db-ojb-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From to...@apache.org
Subject cvs commit: db-ojb/src/doc/forrest/src/documentation/content/xdocs/docu/guides xdoclet-module.xml
Date Wed, 17 Nov 2004 23:35:26 GMT
tomdz       2004/11/17 15:35:26

  Modified:    src/doc/forrest/src/documentation/content/xdocs/docu/guides
                        xdoclet-module.xml
  Log:
  Enhanced xdoclet module documentation a bit
  
  Revision  Changes    Path
  1.5       +12 -14    db-ojb/src/doc/forrest/src/documentation/content/xdocs/docu/guides/xdoclet-module.xml
  
  Index: xdoclet-module.xml
  ===================================================================
  RCS file: /home/cvs/db-ojb/src/doc/forrest/src/documentation/content/xdocs/docu/guides/xdoclet-module.xml,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- xdoclet-module.xml	26 Jun 2004 23:45:15 -0000	1.4
  +++ xdoclet-module.xml	17 Nov 2004 23:35:25 -0000	1.5
  @@ -430,10 +430,11 @@
                           <strong>generate-table-info : true (default) | false</strong>
                       </dt>
                       <dd>
  -                        This attribute controls whether the type has data and should therefore
get a torque table
  -                        descriptor. When set to
  -                        <code>false</code>, no field, reference or collection
descriptors are
  -                        generated.
  +                        This attribute controls whether the type has data. If set to <code>true</code>,
the field,
  +                        reference and collection descriptors will be present in the repository
file and a torque
  +                        table descriptor will be created in the database schema. When set
to <code>false</code>,
  +                        only the inheritance information but no field, reference or collection
descriptors are
  +                        generated in the repository file and no table will be in the database
schema.
                           <br/>
                       </dd>
   
  @@ -1319,8 +1320,7 @@
                       bean property is used for naming purposes (e.g. "value" for a method
                       <code>getValue()</code>). The
                       XDoclet OJB module ensures that a field is not present more than once,
therefore it is safe to mark
  -                    both fields and their accessors. However, in that case the three
  -                    <strong>ojb.field</strong> tags are required to
  +                    both fields and their accessors. However, in that case these <strong>ojb.field</strong>
tags are required to
                       have the same attributes.
                   </p>
                   <p>
  @@ -1334,19 +1334,17 @@
                       tag having the
                       <strong>include-inherited</strong> attribute set to
                       <code>true</code>.
  -                    <br/>
  +                </p>
  +                <p>
                       It is also possible to use the
                       <strong>ojb.field</strong> tag at the class level (i.e.
in the JavaDoc comment of
                       the class). In this case, the tag is used to define an
                       <em>anonymous</em> field, e.g. a "field" that has
                       no counterpart in the class but exists in the database. For anonymous
fields, both the
  -                    <strong>name</strong> and
  -                    the
  -                    <strong>jdbc-type</strong> attributes are required, and
the
  -                    <strong>access</strong> attribute is ignored (it defaults
  -                    to the value
  +                    <strong>name</strong> and the <strong>jdbc-type</strong>
attributes are required, and the
  +                    <strong>access</strong> attribute is ignored (it defaults
to the value
                       <code>anonymous</code>). Beside these differences, anonymous
fields are handled like
  -                    other fields, (e.g. they result in field-descriptor entries in the
repository descriptor, and in
  +                    other fields, e.g. they result in field-descriptor entries in the repository
descriptor, and in
                       columns in the table schema, and they are inherited and can be modified
via the
                       <link href="#ojb.modify-inherited">ojb.modify-inherited</link>
tag.
                   </p>
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: ojb-dev-unsubscribe@db.apache.org
For additional commands, e-mail: ojb-dev-help@db.apache.org


Mime
View raw message