Commons Digester
  1. Commons Digester
  2. DIGESTER-45

[digester] Add usage example to ExtendedBaseRules javadoc

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: Nightly Builds
    • Fix Version/s: None
    • Labels:
      None
    • Environment:

      Operating System: Windows XP
      Platform: PC

      Description

      Other than the package documentation (which I didn't find until after I figured
      this out) there is no example of using an alternate 'matching policy' such as
      ExtendedBaseRules with Digester. It's a simple thing to do, but it wasn't
      obvious to me, so here's a suggestion for the Javadoc.

        Activity

        Hide
        Wendy Smoak added a comment -

        Created an attachment (id=14029)
        Suggestion for usage example in Javadoc

        Re-writes welcome, this could probably be clearer, but the code example gets
        the point across.

        Show
        Wendy Smoak added a comment - Created an attachment (id=14029) Suggestion for usage example in Javadoc Re-writes welcome, this could probably be clearer, but the code example gets the point across.
        Hide
        Wendy Smoak added a comment -

        Also, I'm unable to build the javadoc locally with Ant, I get the following
        error, apparently due to the quotes around "AS IS" in build.xml:

        <target name="javadoc" depends="compile"
        ...
        <javadoc sourcepath="$

        {source.home}

        "
        ...
        bottom='Copyright (c) 2001-2004 - Apache Software Foundation
        Unless required by applicable law or agreed to in writing, software
        distributed under the License is distributed on an "AS IS" BASIS,

        The error:

        javadoc:
        [mkdir] Created dir: E:\cvs\jakarta-commons\digester\dist
        [mkdir] Created dir: E:\cvs\jakarta-commons\digester\dist\docs
        [mkdir] Created dir: E:\cvs\jakarta-commons\digester\dist\docs\api
        [javadoc] Generating Javadoc
        [javadoc] Javadoc execution
        [javadoc] javadoc: Illegal package name: "IS BASIS, WITHOUT WARRANTIES OR C
        ONDITIONS OF ANY KIND, either express or implied. See the License for the spe
        cific language governing permissions and limitations under the License.
        -->"

        Show
        Wendy Smoak added a comment - Also, I'm unable to build the javadoc locally with Ant, I get the following error, apparently due to the quotes around "AS IS" in build.xml: <target name="javadoc" depends="compile" ... <javadoc sourcepath="$ {source.home} " ... bottom='Copyright (c) 2001-2004 - Apache Software Foundation Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, The error: javadoc: [mkdir] Created dir: E:\cvs\jakarta-commons\digester\dist [mkdir] Created dir: E:\cvs\jakarta-commons\digester\dist\docs [mkdir] Created dir: E:\cvs\jakarta-commons\digester\dist\docs\api [javadoc] Generating Javadoc [javadoc] Javadoc execution [javadoc] javadoc: Illegal package name: "IS BASIS, WITHOUT WARRANTIES OR C ONDITIONS OF ANY KIND, either express or implied. See the License for the spe cific language governing permissions and limitations under the License. -->"
        Hide
        Simon Kitching added a comment -

        Hi Wendy,

        I've updated the javadoc for ExtendedBaseRules with a variant of your patch.
        NB: I also took the opportunity to fix a few other minor issues with the javadoc
        for that class.

        Re errors when building javadoc with Ant: I can't replicate this (java 1.5 on
        linux). It works fine for me. Note that the double-quotes within the copyright
        text should be fine, as single-quotes are being used to delimit that xml
        attribute. If you are still having problems, please post to the dev list to
        discuss it, and indicate your java version, platform, etc.

        Thanks for your patch!

        Show
        Simon Kitching added a comment - Hi Wendy, I've updated the javadoc for ExtendedBaseRules with a variant of your patch. NB: I also took the opportunity to fix a few other minor issues with the javadoc for that class. Re errors when building javadoc with Ant: I can't replicate this (java 1.5 on linux). It works fine for me. Note that the double-quotes within the copyright text should be fine, as single-quotes are being used to delimit that xml attribute. If you are still having problems, please post to the dev list to discuss it, and indicate your java version, platform, etc. Thanks for your patch!

          People

          • Assignee:
            Unassigned
            Reporter:
            Wendy Smoak
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development