You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@avalon.apache.org by mc...@apache.org on 2003/07/26 09:54:00 UTC
cvs commit: avalon-sandbox/meta/site/xdocs/tools/tags configuration.xml
mcconnell 2003/07/26 00:54:00
Added: meta/site/xdocs/tools/tags configuration.xml
Log:
Addition of documentation for the configuration tag.
Revision Changes Path
1.1 avalon-sandbox/meta/site/xdocs/tools/tags/configuration.xml
Index: configuration.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<author email="mcconnell@apache.org">Stephen McConnell</author>
<title>Javadoc Tag Specification</title>
</properties>
<body>
<section name="Javadoc Tags">
<subsection name="Configuration Tag">
<p>The optional configuration tag allows the declaration of a validation schema with a component type.</p>
</subsection>
<subsection name="Attributes">
<table>
<tr><th>Attribute</th><th>Required</th><th>Description</th></tr>
<tr>
<td>schema</td><td>yes</td>
<td>
The validate schema name.
</td>
</tr>
</table>
</subsection>
<subsection name="Example">
<source><![CDATA[
/**
* Configuration of the component by the container.
* @param config the configuration instance
* @exception ConfigurationException if error occurs
* @avalon.configuration schema="your-schema-spec"
*/
public void configure( Configuration config ) throws ConfigurationException
{
...
}
]]></source>
<p>Generated meta-info type descriptor:</p>
<source><![CDATA[
<type>
<info>
<schema>your-schema-spec</schema>
</info>
</type>
]]></source>
</subsection>
</section>
</body>
<footer>
<legal>
Copyright (c) @year@ The Avalon Apache Project All rights reserved.
$Revision: 1.1 $ $Date: 2003/07/26 07:54:00 $
</legal>
</footer>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@avalon.apache.org
For additional commands, e-mail: cvs-help@avalon.apache.org