avalon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dona...@apache.org
Subject cvs commit: jakarta-avalon-excalibur/info/src/xdocs doclet.xml
Date Wed, 13 Nov 2002 02:11:47 GMT
donaldp     2002/11/12 18:11:46

  Modified:    info/src/xdocs doclet.xml
  Log:
  Update doc to have a generic schema handling for both parameters and configuration
  
  Revision  Changes    Path
  1.3       +18 -14    jakarta-avalon-excalibur/info/src/xdocs/doclet.xml
  
  Index: doclet.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-excalibur/info/src/xdocs/doclet.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- doclet.xml	13 Nov 2002 01:42:49 -0000	1.2
  +++ doclet.xml	13 Nov 2002 02:11:46 -0000	1.3
  @@ -34,6 +34,10 @@
                   <li><a href="#avalon.configuration">avalon.configuration</a></li>
                   <li><a href="#avalon.parameters">avalon.parameters</a></li>
               </ul>
  +            <p>An example of processing the
  +            <a href="MyComponent.java.txt">MyComponent.java</a> to produce
  +            <a href="MyComponent-info.xml.txt">MyComponent-info.xml</a> is
  +            available.</p>
               <subsection name="avalon.component">
                   <table>
                       <tr>
  @@ -312,12 +316,12 @@
                       <tr>
                           <td>Parameters</td>
                           <td>The avalon.configuration has one parameter;
  -                        <em>schema</em>. "schema" indicates the location
  -                        of the schema definition file for configuration.
  -                        Several different schema types are supported such
  -                        as W3C XMLSchema, DTD, Relax NG etc. If the
  -                        parameter is unspecified it defaults to
  -                        "{componentname}-schema.xml".</td>
  +                        <em>location</em>. "location" indicates the location
  +                        of the schema definition file for configuration
  +                        (relative to the Component). Several different schema
  +                        types are supported such as W3C XMLSchema, DTD,
  +                        Relax NG etc. If the parameter is unspecified it
  +                        defaults to "{componentname}-schema.xml".</td>
                       </tr>
                   </table>
                   <p>Example:</p>
  @@ -330,7 +334,7 @@
   ]]></source>
                   <p>Will produce the following part of xml info descriptor:</p>
   <source><![CDATA[
  -  <configuration schema="MyComponent-schema.xml"/>
  +  <schema category="configuration" location="MyComponent-schema.xml"/>
   ]]></source>
               </subsection>
               <subsection name="avalon.parameters">
  @@ -349,25 +353,25 @@
                       <tr>
                           <td>Parameters</td>
                           <td>The avalon.parameters has one parameter;
  -                        <em>schema</em>. "schema" indicates the location
  -                        of the schema definition file for parameters.
  -                        If the parameter is unspecified it defaults to
  -                        "{componentname}-schema.xml". Note that currently
  -                        there is no supported schema for parameters
  +                        <em>location</em>. "location" indicates the location
  +                        of the schema definition file for parameters (relative
  +                        to the Component). If the parameter is unspecified it
  +                        defaults to "{componentname}-schema.xml". Note that
  +                        currently there is no supported schema for parameters
                           objects.</td>
                       </tr>
                   </table>
                   <p>Example:</p>
   <source><![CDATA[
   /**
  - * @avalon.parameters schema="Foo.xml"
  + * @avalon.parameters location="Foo.xml"
    */
   public void parameterize( Parameters parameters )
       throws ParametersException
   ]]></source>
                   <p>Will produce the following part of xml info descriptor:</p>
   <source><![CDATA[
  -  <parameters schema="Foo.xml"/>
  +  <schema category="parameters" location="Foo.xml"/>
   ]]></source>
               </subsection>
           </section>
  
  
  

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


Mime
View raw message