Results 1 to 3 of 3

Thread: Need XML bean definition documentation?

  1. #1
    Join Date
    Aug 2004
    Location
    u.s.a
    Posts
    399

    Default Need XML bean definition documentation?

    Yup, I know about the javadocs, the dtd, and the jira issue on documentation. This might be a little different.

    Look at Ant or even Maven, the target or goals are documented in a different manner than javadocs. This helps since going from an api description in javadocs or some other manner to the actual xml bean descriptor 'syntax' is hard. Reading a DTD to determine what is allowed is not enjoyable.

    Sure editors fill in the xml stuff based on the DTD but this does not help reading and understanding something, only using it.

    Right now I use the Reference docs, javadocs, unit tests, and the book to try to understand something. Sometimes the unit tests are the best. Which just adds to the unit tests being a good thing.

  2. #2
    Join Date
    Aug 2004
    Location
    Toronto, Canada
    Posts
    736

    Default

    the current rev of the beans chapter in the reference docs actually should cover all the constructs avialable in the XML bean definition.

    Since the same stuff is also included in the dtd, I'm not actually that clear on what extra information you'd like documented elsewhere or in another fashion...
    Colin Sampaleanu
    SpringSource - http://www.springsource.com

  3. #3
    Join Date
    Aug 2004
    Location
    u.s.a
    Posts
    399

    Default

    I was really only referring to the style of documentation, specifically how Ant does it. Its pretty easy to use. I think they use xdoclet to generate it.

    But, its not a biggie.

Similar Threads

  1. Order of Bean definitions matters?
    By cfuser in forum Container
    Replies: 2
    Last Post: Oct 21st, 2005, 10:29 AM
  2. Spring container fails with no exception
    By naor in forum Container
    Replies: 9
    Last Post: Oct 1st, 2005, 03:39 PM
  3. EHCaching Hibernate
    By dencamel in forum Data
    Replies: 3
    Last Post: Sep 6th, 2005, 09:03 PM
  4. could not satisfy dependencies
    By springuser in forum Container
    Replies: 4
    Last Post: Apr 26th, 2005, 01:15 PM
  5. Replies: 1
    Last Post: Apr 25th, 2005, 07:37 PM

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •