[jboss-cvs] JBossAS SVN: r93010 - projects/annotations/trunk/doc/userguide/en/modules.

[jboss-cvs-commits at lists.jboss.org]

Author: jesper.pedersen
Date: 2009-08-30 12:29:22 -0400 (Sun, 30 Aug 2009)
New Revision: 93010

Modified:
   projects/annotations/trunk/doc/userguide/en/modules/introduction.xml
   projects/annotations/trunk/doc/userguide/en/modules/usage.xml
Log:
[JBANN-23] Describe functionality

Modified: projects/annotations/trunk/doc/userguide/en/modules/introduction.xml
===================================================================
--- projects/annotations/trunk/doc/userguide/en/modules/introduction.xml	2009-08-30 16:13:37 UTC (rev 93009)
+++ projects/annotations/trunk/doc/userguide/en/modules/introduction.xml	2009-08-30 16:29:22 UTC (rev 93010)
@@ -14,7 +14,7 @@
        Tools: Various tools
        <itemizedlist spacing="compact">
          <listitem>
-           Indexer: An index tool that can generate jboss-annotation.xml and jboss-annotation.ser files.
+           Indexer: An index tool that can generate metadata about annotation locations.
          </listitem>
        </itemizedlist>
      </listitem>
@@ -33,16 +33,18 @@
           Class level: Annotations located on interface or class definitions.
         </listitem>
         <listitem>
-          Field level: Annotations located on fields (private to public).
+          Field level: Annotations located on fields.
         </listitem>
         <listitem>
-          Constructor level: Annotations located on constructors (private to public).
+          Constructor level: Annotations located on constructors.
         </listitem>
         <listitem>
-          Method level: Annotations located on methods (private to public).
+          Method level: Annotations located on methods.
         </listitem>
       </itemizedlist>
 
+      <para>The scanner scans from private to public visibility in all levels.</para>
+
       <para>Parameter level annotation scanning is on the project's roadmap (JBANN-14).</para>
 
       <para>Also on the roadmap is the ability to define which of the above levels
@@ -51,27 +53,18 @@
       <section id="metadata">
         <title>Metadata</title>
 
-        <para>The scanner uses the metadata files</para>
+        <para>The scanner uses the metadata file</para>
 
         <itemizedlist spacing="compact">
           <listitem>
-            META-INF/jboss-annotation.ser (Binary)
+            META-INF/jboss-annotation.ser
           </listitem>
-          <listitem>
-            META-INF/jboss-annotation.xml (XML)
-          </listitem>
         </itemizedlist>
 
         <para>to limit the scanning needed for each archive.</para>
 
-        <para>The format of the XML file can be found in the file</para>
+        <para>The metadata file is created by the Indexer Ant task.</para>
 
-        <programlisting>
-jboss-annotation.xsd
-        </programlisting>
-
-        <para>Both metadata file types can be created by using the Indexer Ant task.</para>
-
       </section>
 
    </section>

Modified: projects/annotations/trunk/doc/userguide/en/modules/usage.xml
===================================================================
--- projects/annotations/trunk/doc/userguide/en/modules/usage.xml	2009-08-30 16:13:37 UTC (rev 93009)
+++ projects/annotations/trunk/doc/userguide/en/modules/usage.xml	2009-08-30 16:29:22 UTC (rev 93010)
@@ -25,7 +25,7 @@
 AnnotationRepository ar = as.scan(urls);
 
 // Query the repository for an annotation and receive a list of instances
-List&lt;Annotation&gt; l = ar.getAnnotation(MyAnnotation.class);
+Collection&lt;Annotation&gt; l = ar.getAnnotation(MyAnnotation.class);
 
 // Use each annotation
 if (l != null)