coherent (castorbuilder) properties comments and values

Details

  • Type: Wish Wish
  • Status: Closed Closed
  • Priority: Trivial Trivial
  • Resolution: Fixed
  • Affects Version/s: None
  • Fix Version/s: 1.3
  • Component/s: XML code generator
  • Labels:
    None
  • Environment:
    does it matter?

Description

The default castorbuilder properties file as contained in the codegen jar uses incoherent style of documenting a default value and actually setting a default value. Following styles are used:

    1. blah blah
  2. default value is "x"
  3. blah=y
    (showing the alternative, not setting a default explicitely)
    1. blah blah
  2. default value is "x"
    blah=y
    (comment out of date)
    1. blah blah
  2. default value is "x"
    blah=x
    (explicitely setting the default value)

Wish: use coherent style. Suggest using "default value as documented in comment equals explicitely set property" throughout.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Martin S. Weber added a comment -

Grr. Hit create too early.
a) applies to xml code generator part of castor
b) those numbered lists up there were supposed to be '#'s indicating comments in the properties file. So in your mind replace all "[123]. " with "#" when reading the above.

Show
Martin S. Weber added a comment - Grr. Hit create too early. a) applies to xml code generator part of castor b) those numbered lists up there were supposed to be '#'s indicating comments in the properties file. So in your mind replace all "[123]. " with "#" when reading the above.
Hide
Permalink
Martin S. Weber added a comment -

This doesn't apply only to the code generator it seems.
Looking at the section 1.5.4 of the current reference documentation, you'll notice:

# True if all documents should be indented on output by default.
# Defaults to false.
#
#org.exolab.castor.indent=true

# True if xml documents should be validated by the SAX Parser
# Defaults to false.
#
org.exolab.castor.parser.validation=false

as well as other options not documenting the default value at all, but rather just set them.

Show
Martin S. Weber added a comment - This doesn't apply only to the code generator it seems. Looking at the section 1.5.4 of the current reference documentation, you'll notice: 
# True if all documents should be indented on output by default.
# Defaults to false.
#
#org.exolab.castor.indent=true

# True if xml documents should be validated by the SAX Parser
# Defaults to false.
#
org.exolab.castor.parser.validation=false
as well as other options not documenting the default value at all, but rather just set them.
Hide
Permalink
Ralf Joachim added a comment -

Let's see if Werner prefers to move this issue to XML component or create a seperate issue for castor.properties.

Show
Ralf Joachim added a comment - Let's see if Werner prefers to move this issue to XML component or create a seperate issue for castor.properties.
Hide
Permalink
Werner Guttmann added a comment -

Ralf, I'll deal with this through this issue.

Show
Werner Guttmann added a comment - Ralf, I'll deal with this through this issue.
Hide
Permalink
Werner Guttmann added a comment -

Martin, I think I'll drop section 1.5.4 completely. There's no need to have this anymore.

Show
Werner Guttmann added a comment - Martin, I think I'll drop section 1.5.4 completely. There's no need to have this anymore.
Hide
Permalink
Martin S. Weber added a comment -

Please have a look at all your properties file to see if the reported inconsistency exists there. I was just quoting that section of the ref doc as it includes another properties file. I think all your (default) properties files (and their documentation) should follow one single coherent style.

Show
Martin S. Weber added a comment - Please have a look at all your properties file to see if the reported inconsistency exists there. I was just quoting that section of the ref doc as it includes another properties file. I think all your (default) properties files (and their documentation) should follow one single coherent style.
Hide
Permalink
Werner Guttmann added a comment -

I will be dealing with this through the child tasks.

Show
Werner Guttmann added a comment - I will be dealing with this through the child tasks.

People

  • Assignee:
    Werner Guttmann
    Reporter:
    Martin S. Weber
Vote (0)
Watch (1)

Dates

  • Created:
    Updated:
    Resolved: