[jboss-cvs] jboss-seam/doc/reference/en/modules ...

[Gavin King]

  User: gavin   
  Date: 06/10/16 08:15:25

  Modified:    doc/reference/en/modules  annotations.xml
  Log:
  doc new well-defined rules for @Out
  
  Revision  Changes    Path
  1.45      +18 -10    jboss-seam/doc/reference/en/modules/annotations.xml
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: annotations.xml
  ===================================================================
  RCS file: /cvsroot/jboss/jboss-seam/doc/reference/en/modules/annotations.xml,v
  retrieving revision 1.44
  retrieving revision 1.45
  diff -u -b -r1.44 -r1.45
  --- annotations.xml	16 Oct 2006 11:51:11 -0000	1.44
  +++ annotations.xml	16 Oct 2006 12:15:25 -0000	1.45
  @@ -252,19 +252,25 @@
                      <programlisting><![CDATA[@Out]]></programlisting>
                       <para>
                           Specifies that a component attribute that is a Seam component is to be 
  -                        outjected to a context variable at the end of the invocation. If the
  +                        outjected to its context variable at the end of the invocation. If the 
                           attribute is null, an exception is thrown.
                       </para>
                       <programlisting><![CDATA[@Out(required=false)]]></programlisting>
                       <para>
                           Specifies that a component attribute that is a Seam component is to be 
  -                        outjected to a context variable at the end of the invocation. The
  +                        outjected to its context variable at the end of the invocation. The 
                           attribute may be null.
                       </para>
                       <programlisting><![CDATA[@Out(scope=ScopeType.SESSION)]]></programlisting>
                       <para>
  -                        Specifies that a component attribute that is not a Seam component is to 
  -                        be outjected to a specific scope at the end of the invocation.
  +                        Specifies that a component attribute that is <emphasis>not</emphasis> 
  +                        a Seam component type is to be outjected to a specific scope at the end 
  +                        of the invocation.
  +                    </para>
  +                    <para>
  +                        Alternatively, if no scope is explictly specified, the scope of the 
  +                        component with the <literal>@Out</literal> attribute is used (or the 
  +                        <literal>EVENT</literal> scope if the component is stateless).
                       </para>
                      <programlisting><![CDATA[@Out(value="contextVariableName")]]></programlisting>
                       <para>
  @@ -338,7 +344,9 @@
                           Specifies that the method returns a value that Seam should use to 
                           initialize the value of the named context variable, when the context 
                           variable has no value. This style is used with methods that return 
  -                        a value.
  +                        a value. If no scope is explicitly specified, the scope of the component 
  +                        with the <literal>@Factory</literal> method is used (unless the component
  +                        is stateless, in which case the <literal>EVENT</literal> context is used).
                       </para>
                       <itemizedlist>
                           <listitem>