[seam-issues] [JBoss JIRA] (SOLDER-287) Solder documentation issues

[Jason Porter (Assigned) (JIRA)]

     [ https://issues.jboss.org/browse/SOLDER-287?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Jason Porter reassigned SOLDER-287:
-----------------------------------

    Assignee: Jason Porter

    
> Solder documentation issues
> ---------------------------
>
>                 Key: SOLDER-287
>                 URL: https://issues.jboss.org/browse/SOLDER-287
>             Project: Seam Solder
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 3.1.0.Beta3
>            Reporter: Marek Schmidt
>            Assignee: Jason Porter
>             Fix For: 3.1.0.Final
>
>
>         "Seam Solder" still mentioned in several places (e.g. the header), I am not sure if that term should still be used or not.
>         Chapter 1 Getting Started
>             1.2. Transitive dependencies
>                 the "tip" still contains old groupId and artifactId (org.jboss.seam.solder, seam-solder-parent, seam.solder.version)
>             1.3. Pre-Servlet 3.0 configuration
>                 org.jboss.seam.solder.resourceLoader.servlet.ResourceListener
>         Chapter 3 Annotation Literals
>             @GenericConfiguration literal is not mentioned in the list of literals
>         Chapter 4 Evaluating Unified EL
>             missing description of the @Resolver annotation
>         Chapter 6 Logging, redesigned
>             "The license for Seam is " confusing to have Seam in the example if Solder is not part of Seam anymore
>             6.4 Native logger API
>                 it should probably be "org.jboss.solder.logging.Logger;"  instead of "org.jboss.logging.Logger;"
>             6.6.1. Generating the implementation classes
>                 "TrainMessages_fr.i18n.properties"  should be "TrainMessages.i18n_fr.properties" instead
>         Chapter 7 Annotation and AnnotatedType Utilities
>             7.1  Annotated Type Builder
>              in the 1st code block, "AnnotatedTypeBuilder builder = new AnnotatedTypeBuilder() ...  .create()"   the last line (".create()") should not be there.
>              in the 4th code block, "RedefinitionContext<A>" should probably be "RedefinitionContext<Unique>" instead, 
>              in the 4th code block, the ".create();" line should not be there.
>             7.3. Annotation Inspector
>                 1st code block, AnnotationInspector.getAnnotations should have only two arguments
>         Chapter 8. Obtaining a reference to the BeanManager
>             "When developing a framework that builds on CDI, you may need to obtain the BeanManager for the application, can't simply inject it as you are not working in an object managed by the container. "   missing "you" before "can't simply inject"?
>         Chapter 10. Properties
>             Table 10.1 Property methods
>                 methods "Member getMember();" and "void setAccessible()" are not mentioned in the table, could be intentional.
>         Chapter 11. Unwrapping Producer Methods
>              "The lifecycle of the bean is are managed by the bean that defines the producer method " one "are" too many.
>         Chapter 13. Generic Beans  
>             13.1 Using generic beans
>                 "Seam XML" is mentioned twice
>         
>         Chapter 15. XML Configuration Introduction
>             error in formatting in the HTML output, some XML piece 'ml_plain">' on each line in the example
>             "mvn jetty:run"  it has to be "mvn -Pjetty jetty:run" now, either the example or the docs should be fixed
>         Chapter 16.1 XML Namespaces           
>             namespaces need to be updated:
>                 org.jboss.weld.extensions.core
>                 org.jboss.weld.extensions.unwraps
>                 org.jboss.weld.extensions.resourceLoader 
>         Chapter 16.2 Adding, replacing and modifying beans
>             (or somewhere else) there should be a note on how s:modifies behaves with @Veto
>         18.3.1. @HandlesExceptions
>             "The @HandlesExceptions annotation may be deprecated in favor of annotation indexing done by Solder. "    
>                 the link links to http://seamframework.org/Seam3/Solder which doesn't make sense, as this text is now inside the solder documentation.
>         18.3.2. @Handles
>             "stout" typo? (stdout)
>         20.3. Supporting ServiceHandlers
>             "ServiceHandlers make for a very easy and concise way to define exception handlers." link to ServiceHandlers should now be an internal one, as this document is now the solder documenation.
>             "The following example comes from the jaxrs example in the distribution", there is no "jaxrs" example in the Solder distribution
>    
>         24.2. Defining a exception handler for a web request
>             "Currently, @WebRequest is required to catch exceptions initiated by the Servlet integration because of a bug in Solder." 
>                 is this stll true? SOLDER-130 is marked as resolved, Should @Any be used?

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.jboss.org/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira