CVS update of web/xml/root/tutorials/fraclet (index.xml)

[Nicolas Pessemier <pessemier@xxxxxxxxxxxxxxxxxxxxxxxxx>]

    Date: Friday, March 31, 2006 @ 11:45:52
  Author: pessemier
    Path: /cvsroot/fractal/web/xml/root/tutorials/fraclet

Modified: index.xml

Add documentation for the following elelments:
+ controllerDesc parameter in @FractalComponent
+ signature parameter in @FractalBC
+ @FractalRC to get the Component reference


-----------+
 index.xml |   41 +++++++++++++++++++++++++++++++++++++++--
 1 files changed, 39 insertions(+), 2 deletions(-)


Index: web/xml/root/tutorials/fraclet/index.xml
diff -u web/xml/root/tutorials/fraclet/index.xml:1.3 
web/xml/root/tutorials/fraclet/index.xml:1.4
--- web/xml/root/tutorials/fraclet/index.xml:1.3        Sun Mar 19 15:28:54 
2006
+++ web/xml/root/tutorials/fraclet/index.xml    Fri Mar 31 11:45:52 2006
@@ -768,6 +768,13 @@
                         <td>Class</td>
                         <td>Annotation to specify that the component 
provides a server interface which is not annotated with a 
<em>@FractalItf</em> (such as <em>java.lang.Runnable</em>).</td>
                   </tr>
+                                       <tr>
+                        <td><connect 
href="index.xml#fractalrc"><code>@FractalRC</code></connect></td>
+                        <td>Field</td>
+                        <td>Annotation to get the component part 
reference.</td>
+                  </tr>
+                                       
+                                       fractalrc
                 </table>
 
                                <p>Note that all these annotations are also 
used to generate .fractal files for Fractal-ADL. See the revisiting of the 
Hello World example for more details</p>
@@ -786,9 +793,14 @@
                   </tr>
                   <tr>
                         <td>name</td>
-                        <td>the name of the Fractal component</td>
+                        <td>the name of the Fractal component.</td>
                         <td>Required</td>
                   </tr> 
+                                 <tr>
+                        <td>controllerDesc</td>
+                        <td>the membrane description of the Fractal 
component. For instance "primitive".</td>
+                        <td>Optional</td>
+                  </tr> 
                                </table>
                 <p><strong>Examples:</strong></p>         
                 <source>
@@ -1045,6 +1057,11 @@
                         <td>name</td>
                         <td>the name of the Fractal binding.</td>
                         <td>Required<br/></td>
+                  </tr>    
+                                 <tr>
+                        <td>signature</td>
+                        <td>the signature of the Fractal binding. Use this 
parameter only to generate Java 1.4 compatible code for collection 
interfaces. Don't use this parameter for singleton interfaces.</td>
+                        <td>Optional<br/>(default value is 
<code>None.class</code>)</td>
                   </tr>                 
                   <tr>
                         <td>contingency</td>
@@ -1213,7 +1230,24 @@
   &lt;content class="primitive.Client"/&gt;
 &lt;/definition&gt;
                        </source>       
-             </s2>
+               
+               
+                                                                     
<subtitle anchor="fractalrc">@fractalRC</subtitle>   
+                <p><strong>Details:</strong></p>
+                <p>This field annotation provides a way to get a reference 
of the <strong>Component part</strong>.</p>
+                                          
<p><strong>Parameters:</strong></p>         `
+                                       <p>No parameters</p>
+          
+                <p><strong>Example:</strong></p>         
+                <source>
+public class Client implements Runnable {
+  @FractalRC
+  private Component c; 
+}
+                </source>
+               
+               
+                             </s2>
                          
                          
                          
@@ -1282,6 +1316,8 @@
                 <p>This definition creates a composite component 
<code>HelloWorld</code>.
                   Then it specifies that the definition of the component 
named <code>server</code> is <code>Server</code> and that the values of the 
<code>header</code> and the <code>counter</code> attributes are 
<code>'&gt;&gt;'</code> and <code>2</code>, respectively.</p>
  
+                               
+                               
                 <subtitle anchor="artifacts">Directory Structure</subtitle>
                 <p>The directory structure below presents the list of 
compiled, generated and written files when using Fraclet to implement the 
HelloWorld example:</p>
                 <source>
@@ -1311,6 +1347,7 @@
     - Server.java
     - Service.java
                 </source>
+                               
                          </s2>
                          
           </s1>