[seam-issues] [JBoss JIRA] Created: (SOLDER-73) Misc documentation issues

Jozef Hartinger (JIRA) jira-events at lists.jboss.org
Thu Feb 3 08:42:39 EST 2011


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

                 Key: SOLDER-73
                 URL: https://issues.jboss.org/browse/SOLDER-73
             Project: Seam Solder
          Issue Type: Bug
          Components: Documentation
    Affects Versions: 3.0.0.Beta3
            Reporter: Jozef Hartinger
            Priority: Minor


* Section 1.2
** remove org.jboss.logging:jboss-logging as a transitive dependency
** change "Most of Seam Solder has very few dependencies, only one of which is not provided by Java EE 6:" to reflect reality
* Chapter 3 - "Annotations without *listitems* provide a static INSTANCE *listitem* that should be used rather than creating a new instance every time." - this probably talks about annotations without *members* - IMHO it is not correct to reference annotation members as "listitems" - at least the CDI spec uses the term *member*
* Chapter 6
** "Access to MDC and NDC" - personally, I have no idea what *MDC* and *NDC* mean - consider explaining / using full name / providing a link
* Chapter 7
** " This chapter will walk you each utility" - should be "This chapter will walk you *through* each utility"
** s/javaodoc/javadoc
* Section 7.1
** s/Seam Solder provides an AnnotatedType implementation that should be suitable for most portable extensions needs./Seam Solder provides an AnnotatedType implementation that should be suitable for most portable *extensions'* needs. 
* Chapter 14 - s/intercepter/interceptor


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

        


More information about the seam-issues mailing list