You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@avalon.apache.org by ni...@apache.org on 2004/03/12 15:49:57 UTC

cvs commit: avalon/merlin/platform/xdocs/starting/tutorial creation.xml

niclas      2004/03/12 06:49:57

  Modified:    merlin/platform/xdocs/starting/tutorial creation.xml
  Log:
  Some changes suggested by Daniel Frey, to make it easier to understand what is what.
  
  Revision  Changes    Path
  1.3       +23 -15    avalon/merlin/platform/xdocs/starting/tutorial/creation.xml
  
  Index: creation.xml
  ===================================================================
  RCS file: /home/cvs/avalon/merlin/platform/xdocs/starting/tutorial/creation.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- creation.xml	25 Jan 2004 13:28:50 -0000	1.2
  +++ creation.xml	12 Mar 2004 14:49:57 -0000	1.3
  @@ -130,24 +130,32 @@
         <subsection name="Creating a Type Descriptor">
         
           <p>
  -        In order for Merlin to recognize this class as a component, we need to 
  -        generate a &lt;classname&gt;.xinfo file. </p>
  -        <p>
  -        The following text
  -        is an example of a component type definition.  It contains the declaration
  -        of the component name and the component implementation version. It was 
  -        generated automatically for us by the pre-goal included in the maven.xml
  -        file.  The avalon:meta plugin looks for @avalon.component tags at class level
  -        and generates component descriptors for us automatically.
  +          In order for Merlin to recognize this class as a component, we need to
  +          generate a &lt;classname&gt;.xinfo file. However, this can be done
  +          automatically by including a pre-goal as shown below into the 
  +          maven.xml file. 
           </p>
   <source><![CDATA[
   <preGoal name="java:compile">
     <attainGoal name="avalon:meta"/>
   </preGoal>
   ]]></source>
  +        <p>
  +          The avalon:meta plugin looks for @avalon tags in the
  +          source code, to generate the correct Type Descriptor. In the above 
  +          example it will find the @avalon.component tag in the class level 
  +          javadocs and generate component the descriptors for us (see below). 
  +        </p>
         </subsection>
   
         <subsection name="Generated Type Descriptor">
  +        <p>
  +          The following text is an example of a component type definition.  
  +          It contains the declaration of the component name and the component 
  +          implementation version. From the example above 
  +          ( <code>@avalon.component version="1.0" name="hello"</code> ) the
  +          generated Type Descriptor would look something like this.
  +        </p>
   <source><![CDATA[
   <type>
     <info>
  @@ -161,8 +169,12 @@
         </subsection>
         <subsection name="Creating a block">
           <p>
  -A block is the definition of a composite component. It represents an application made up of a set of components and the supporting resources.  In our example the block will contain the single HelloComponent component.  Based on this information Merlin will create a container and deploy the hello component on startup.
  -       </p>
  +          A block is the definition of a composite component. It represents an
  +          application made up of a set of components and the supporting 
  +          resources.  In our example the block will contain the single 
  +          HelloComponent component.  Based on this information Merlin will 
  +          create a container and deploy the hello component on startup.
  +        </p>
   <source><![CDATA[
   <container name="tutorial">
   
  @@ -189,7 +201,3 @@
     </body>
   
   </document>
  -
  -
  -
  -
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@avalon.apache.org
For additional commands, e-mail: cvs-help@avalon.apache.org