Details

    • Type: Bug
    • Status: Resolved (View Workflow)
    • Priority: Minor
    • Resolution: Done
    • Affects Version/s: 3.0.0.Beta1, 3.0.0.Beta2
    • Fix Version/s: 3.0.0.Final
    • Component/s: Documentation
    • Labels:
      None
    • Affects:
      Documentation (Ref Guide, User Guide, etc.), Release Notes

      Description

      • Chapter 1 - "Catchs" typo
      • Section 3.2.1 Note - missing space - "done bySeam Solder."
      • Example in Section 3.2.2
        • "evt.proceed();" - the proceed method is no longer part of the API
          • also mentioned in the fourth bullet point
        • second bullet point - missing space - "typeCaughtException<T extends Throwable>"
      • Section 3.2.2
        • "Handler methods are similar to CDI observers and, as such, follow the same principals and guidelines as observers" - should be "s/principals/principles" IMHO
        • "unMute()" instead of "unmute()" is mentioned
      • Section 3.3 - missingspaces
        • "such asConstraintViolationException."
        • "If there's a handler forPersistenceException"
        • "Catch is handling theSocketException"
      • Section 3.4.2 "To make specifying precendence values more convenience" - "s/convenience/convenient"
      • Section 3.5.2 Tip
        • meaningless sucsh asEJBException
        • likeSQLException
      • Section 4.2.2 "
        • qualifiers for theCaughtException"
        • "To add a qualifier to be used when firing handlers they must be add to the ExceptionToCatch via the constructor (please see API docs for more info)"
          • they must be added
          • since they probably references the qualifiers, it should probably go something like this: "To add qualifiers to be used when firing handlers, the qualifiers must be added to the ExceptionToCatch via the constructor (please see API docs for more info)"
      • Section 4.3 - "ServiceHandlers make for a very easy and concise way to define exception handlers take the following example comes from the jaxrs example in the distribution:" - this IMHO looks like two or more sentences accidentally put together

        Gliffy Diagrams

          Activity

          Hide
          lightguard Jason Porter added a comment -

          Thanks Jozef.

          Show
          lightguard Jason Porter added a comment - Thanks Jozef.
          Hide
          lightguard Jason Porter added a comment -

          Fixed in dfac436

          Show
          lightguard Jason Porter added a comment - Fixed in dfac436
          Hide
          jharting Jozef Hartinger added a comment -

          The following issues are still not resolved:

          • Catch supports qualifiers for the CaughtException. To add qualifiers to be used when notifying handlers, the qualifiers must be add to the ExceptionToCatch via the constructor (please see API docs for more info).

          The code sample in section 3.2.2 is now broken - the fourth callout is shown as ??? - this is caused by multirename which renamed the callout reference (callout arearefs="markHandled") while the callout definition remained untouched (<area id="proceed" coords="8"/>)

          The rest of the issues were verified. Note that due to SEAMCATCH-47 the docs are currently not available online and need to be built from source.

          Show
          jharting Jozef Hartinger added a comment - The following issues are still not resolved: Catch supports qualifiers for the CaughtException. To add qualifiers to be used when notifying handlers, the qualifiers must be add to the ExceptionToCatch via the constructor (please see API docs for more info). The code sample in section 3.2.2 is now broken - the fourth callout is shown as ??? - this is caused by multirename which renamed the callout reference (callout arearefs="markHandled") while the callout definition remained untouched (<area id="proceed" coords="8"/>) The rest of the issues were verified. Note that due to SEAMCATCH-47 the docs are currently not available online and need to be built from source.
          Hide
          jharting Jozef Hartinger added a comment -
          Show
          jharting Jozef Hartinger added a comment - The following issues still have not been fixed. s/sucsh/such - http://docs.jboss.org/seam/3/3.0.0.CR1/reference/html/catch-client_usage.html#client_usage.api.stackinfo proceed() and proceedToCause() still mentioned in the docs - http://docs.jboss.org/seam/3/3.0.0.CR1/reference/html/catch-client_usage.html#client_usage.api.caughtexception
          Hide
          maschmid Marek Schmidt added a comment -

          One more minor issue:

          the API docs link in 3.5.2. ExceptionStack is wrongly generated, does not link to API docs.

          it should be

          <ulink url="...">
          instead of
          <ulink href="...">

          Show
          maschmid Marek Schmidt added a comment - One more minor issue: the API docs link in 3.5.2. ExceptionStack is wrongly generated, does not link to API docs. it should be <ulink url="..."> instead of <ulink href="...">
          Hide
          shane.bryzak Shane Bryzak added a comment -

          Fixed link to API docs

          Show
          shane.bryzak Shane Bryzak added a comment - Fixed link to API docs

            People

            • Assignee:
              shane.bryzak Shane Bryzak
              Reporter:
              jharting Jozef Hartinger
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development