[seam-issues] [JBoss JIRA] Created: (SEAMCATCH-45) Misc documentation issues

[Jozef Hartinger (JIRA)]

Misc documentation issues
-------------------------

                 Key: SEAMCATCH-45
                 URL: https://issues.jboss.org/browse/SEAMCATCH-45
             Project: Seam Catch
          Issue Type: Bug
          Components: Documentation
    Affects Versions: 3.0.0.Beta1
            Reporter: Jozef Hartinger
            Assignee: Jason Porter
            Priority: Minor
             Fix For: 3.0.0.Beta2


* 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



-- 
This message is automatically generated by JIRA.
-
For more information on JIRA, see: http://www.atlassian.com/software/jira