castor
  1. castor
  2. CASTOR-3194

Class creation mode note mentione din binding docs but not in srcgen properties docs

    Details

    • Type: Improvement Improvement
    • Status: Resolved Resolved
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 1.3.2
    • Fix Version/s: 1.3.3rc1
    • Component/s: XML docs
    • Labels:
      None
    • Number of attachments :
      0

      Description

      In bindings documentation for defaultBindingType there is a note that this element overrides whatever is configured for org.exolab.castor.builder.javaclassmapping in castorbuilder.properties

      On the other hand there is no such note in Class Creation/Mapping docs.

        Activity

        Hide
        Werner Guttmann added a comment -

        Initial patch for review:

        Index: doc/src/docbkx/reference/code-generator.xml
        ===================================================================
        --- doc/src/docbkx/reference/code-generator.xml	(revision 9059)
        +++ doc/src/docbkx/reference/code-generator.xml	(working copy)
        @@ -652,6 +652,12 @@
         # Java class mapping of <xsd:element>'s and <xsd:complexType>'s
         #
         org.exolab.castor.builder.javaclassmapping=type</programlisting>
        +
        +			<para>
        +				Please note that setting this property will not affect class creation when the 
        +				<literal>defaultBindingType</literal> is explicitely used in a binding file. In that case,
        +				the value set there will take precedence.  				
        +			</para>
                  </section>
         
                  <section id="xml.code.generator.properties.detailed.super.class">
        Index: src/doc/srcgen-properties.xml
        ===================================================================
        --- src/doc/srcgen-properties.xml	(revision 9059)
        +++ src/doc/srcgen-properties.xml	(working copy)
        @@ -376,6 +376,12 @@
         # Java class mapping of &lt;xsd:element&gt;'s and &lt;xsd:complexType&gt;'s
         #
         org.exolab.castor.builder.javaclassmapping=type</code-panel>
        +
        +			<note>
        +				Please note that setting this property will not affect class creation when the 
        +				<tt>defaultBindingType</tt> is explicitly used in a binding file. In that case,
        +				the value set there will take precedence.  				
        +			</note>
                  </section>
         
                  <section title="Setting a super class">
        
        

        Please note that I changed the relevant section in the reference guide as well.

        Show
        Werner Guttmann added a comment - Initial patch for review: Index: doc/src/docbkx/reference/code-generator.xml =================================================================== --- doc/src/docbkx/reference/code-generator.xml (revision 9059) +++ doc/src/docbkx/reference/code-generator.xml (working copy) @@ -652,6 +652,12 @@ # Java class mapping of &lt;xsd:element&gt;'s and &lt;xsd:complexType&gt;'s # org.exolab.castor.builder.javaclassmapping=type</programlisting> + + <para> + Please note that setting this property will not affect class creation when the + <literal>defaultBindingType</literal> is explicitely used in a binding file. In that case , + the value set there will take precedence. + </para> </section> <section id= "xml.code.generator.properties.detailed. super .class" > Index: src/doc/srcgen-properties.xml =================================================================== --- src/doc/srcgen-properties.xml (revision 9059) +++ src/doc/srcgen-properties.xml (working copy) @@ -376,6 +376,12 @@ # Java class mapping of &lt;xsd:element&gt;'s and &lt;xsd:complexType&gt;'s # org.exolab.castor.builder.javaclassmapping=type</code-panel> + + <note> + Please note that setting this property will not affect class creation when the + <tt>defaultBindingType</tt> is explicitly used in a binding file. In that case , + the value set there will take precedence. + </note> </section> <section title= "Setting a super class" > Please note that I changed the relevant section in the reference guide as well.
        Hide
        Stevo Slavic added a comment -

        Seems OK.

        Show
        Stevo Slavic added a comment - Seems OK.
        Hide
        Werner Guttmann added a comment -

        Just one more question: hw come you are actually pointing me to the old HTML files (as generated from the XML docs) as opposed to the reference guide ?

        Show
        Werner Guttmann added a comment - Just one more question: hw come you are actually pointing me to the old HTML files (as generated from the XML docs) as opposed to the reference guide ?
        Hide
        Stevo Slavic added a comment -

        Searching for "org.exolab.castor.builder.javaclassmapping" on google returns www.castor.org/srcgen-properties.html as first and reference guide link www.castor.org/reference/html/xml.code.generator.html comes second. If www.castor.org/srcgen-properties.html and similar shouldn't be used, then maybe configure permanent redirect to appropriate pages in reference guide, then google will crawl and update it's index and only reference guide will appear in search results.

        Show
        Stevo Slavic added a comment - Searching for "org.exolab.castor.builder.javaclassmapping" on google returns www.castor.org/srcgen-properties.html as first and reference guide link www.castor.org/reference/html/xml.code.generator.html comes second. If www.castor.org/srcgen-properties.html and similar shouldn't be used, then maybe configure permanent redirect to appropriate pages in reference guide, then google will crawl and update it's index and only reference guide will appear in search results.
        Hide
        Werner Guttmann added a comment -

        Those pages should not be there anymore, to be honest (as they have been moved to the reference guide), and I am having the impression that we actually forgot to delete them in SVN. Thanks for 'pointing this out'.

        Show
        Werner Guttmann added a comment - Those pages should not be there anymore, to be honest (as they have been moved to the reference guide), and I am having the impression that we actually forgot to delete them in SVN. Thanks for 'pointing this out'.
        Hide
        Werner Guttmann added a comment -

        Creating a new follow-up issue re: deletion of outdated documentation.

        Show
        Werner Guttmann added a comment - Creating a new follow-up issue re: deletion of outdated documentation.

          People

          • Assignee:
            Werner Guttmann
            Reporter:
            Stevo Slavic
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: