JDO
  1. JDO
  2. JDO-500

Need better documentation for api2 jdoconfig.xml tests

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: JDO 2 maintenance release 1 (2.1)
    • Fix Version/s: JDO 3 (3.0)
    • Component/s: api, api2-legacy
    • Labels:
      None

      Description

      The api2 tests need a class loader that is configured with or without specific files in the path. This requirement is not well-documented and for maintainability should be documented better.

      1. JDO-500-JDOConfigTestClassLoader.patch
        5 kB
        Richard Schilling
      2. JDO500-JDOHelperConfigTest.patch
        8 kB
        Richard Schilling

        Activity

        Hide
        Craig L Russell added a comment -

        Deferring this, as the code paths are now tested, just need better documentation.

        Show
        Craig L Russell added a comment - Deferring this, as the code paths are now tested, just need better documentation.
        Hide
        Richard Schilling added a comment -

        So, I was looking at this over the weekend, and just want to confirm the specific files that need their javadoc comments updating:

        trunk/api2/test/java/javax/ajdo/JDOConfigTestClassLoader
        trunk/api2/test/java/javax/jdo/JDOHelperConfigTest

        Was that all?

        Show
        Richard Schilling added a comment - So, I was looking at this over the weekend, and just want to confirm the specific files that need their javadoc comments updating: trunk/api2/test/java/javax/ajdo/JDOConfigTestClassLoader trunk/api2/test/java/javax/jdo/JDOHelperConfigTest Was that all?
        Hide
        Craig L Russell added a comment -

        Yes, these are the classes that need a bit more documentation.

        Show
        Craig L Russell added a comment - Yes, these are the classes that need a bit more documentation.
        Hide
        Richard Schilling added a comment -

        Nice. So, the documentation is done. I'm not seeing, however, how to get the maven build to generate the javadoc files for the test classes. They are excluded somehow by default.

        $ maven build

        generates documentation for the api but not the test classes. What am I missing? I'll add the answer to the wiki as well ....

        Show
        Richard Schilling added a comment - Nice. So, the documentation is done. I'm not seeing, however, how to get the maven build to generate the javadoc files for the test classes. They are excluded somehow by default. $ maven build generates documentation for the api but not the test classes. What am I missing? I'll add the answer to the wiki as well ....
        Hide
        Richard Schilling added a comment -

        Oops... I meant

        $ maven javadoc

        Show
        Richard Schilling added a comment - Oops... I meant $ maven javadoc
        Hide
        Richard Schilling added a comment -

        Adding patch file to add re-written Javadoc comments.

        Show
        Richard Schilling added a comment - Adding patch file to add re-written Javadoc comments.
        Hide
        Richard Schilling added a comment -

        Adding patch file to add re-written Javadoc comments.

        Show
        Richard Schilling added a comment - Adding patch file to add re-written Javadoc comments.
        Hide
        Richard Schilling added a comment -

        The files I just uploaded have not actually been run through Javadoc because my maven build because I'm trying to figure out what is wrong with my the maven javadoc target on my machine. Please run these through javadoc and let me know if you want changes. In the meantime, I will also run them through javadoc manually.

        Show
        Richard Schilling added a comment - The files I just uploaded have not actually been run through Javadoc because my maven build because I'm trying to figure out what is wrong with my the maven javadoc target on my machine. Please run these through javadoc and let me know if you want changes. In the meantime, I will also run them through javadoc manually.
        Hide
        Craig L Russell added a comment -

        This is a good start to documenting the jdoconfig tests.

        I think the documentation for the JDOConfigTestClassLoader still needs a bit more work. In particular, the constructor parameter unparent needs to be described better. This is key to the way the class loader works. The idea is that the test's class loader contains a whole lot of things that need to be excluded from the class loader passed to JDOHelper, and there are some parts that need to be added so JDOHelper can find the resources in the right place. This needs to be documented either in the JDOConfigTestClassLoader or in JDOHelperConfigTest.

        Show
        Craig L Russell added a comment - This is a good start to documenting the jdoconfig tests. I think the documentation for the JDOConfigTestClassLoader still needs a bit more work. In particular, the constructor parameter unparent needs to be described better. This is key to the way the class loader works. The idea is that the test's class loader contains a whole lot of things that need to be excluded from the class loader passed to JDOHelper, and there are some parts that need to be added so JDOHelper can find the resources in the right place. This needs to be documented either in the JDOConfigTestClassLoader or in JDOHelperConfigTest.
        Hide
        Craig L Russell added a comment -

        Thanks to Richard for providing the patches for this issue. The test cases are now documented well enough.

        Show
        Craig L Russell added a comment - Thanks to Richard for providing the patches for this issue. The test cases are now documented well enough.

          People

          • Assignee:
            Richard Schilling
            Reporter:
            Craig L Russell
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development