bloritsch 2003/06/24 14:16:07
Modified: csframework AvalonFramework.build
csframework/src/cs/Configuration AbstractConfiguration.cs
IConfigurable.cs IConfiguration.cs
csframework/src/cs/Logger ConsoleLogger.cs Log4netLogger.cs
csframework/src/cs/Parameters IParameterizable.cs
Parameters.cs
csframework/src/cs/Service DefaultServiceManager.cs
Removed: csframework/src/cs/Configuration IReconfigurable.cs
csframework/src/cs/Parameters IReparameterizable.cs
csframework/src/cs/Service DefaultServiceSelector.cs
IServiceSelector.cs
Log:
Update the documentation for the CS code, and remove the cruft that should not be
there to begin with
Revision Changes Path
1.3 +1 -0 avalon-sandbox/csframework/AvalonFramework.build
Index: AvalonFramework.build
===================================================================
RCS file: /home/cvs/avalon-sandbox/csframework/AvalonFramework.build,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- AvalonFramework.build 24 Jun 2003 17:36:41 -0000 1.2
+++ AvalonFramework.build 24 Jun 2003 21:16:06 -0000 1.3
@@ -6,6 +6,7 @@
<target name="build" description="Build the AvalonFramework dll">
<csc target="library"
+ doc="${library.name}.xml"
output="${library.name}.dll"
debug="${build.debug}">
<references basedir="bin">
1.9 +20 -20
avalon-sandbox/csframework/src/cs/Configuration/AbstractConfiguration.cs
Index: AbstractConfiguration.cs
===================================================================
RCS file:
/home/cvs/avalon-sandbox/csframework/src/cs/Configuration/AbstractConfiguration.cs,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- AbstractConfiguration.cs 24 Jun 2003 12:18:24 -0000 1.8
+++ AbstractConfiguration.cs 24 Jun 2003 21:16:06 -0000 1.9
@@ -54,7 +54,7 @@
namespace Apache.Avalon.Framework.Configuration
{
/// <summary>
- /// This is an abstract <see cref="IConfiguration"/> implementation
+ /// This is an abstract <see
cref="Apache.Avalon.Framework.Configuration.IConfiguration"/> implementation
/// that deals with methods that can be abstracted away
/// from underlying implementations.
/// </summary>
@@ -70,11 +70,11 @@
private ConfigurationCollection children = new
ConfigurationCollection();
/// <summary>
- /// Gets a value indicating whether the <see cref="IConfiguration"/>
is read-only.
+ /// Gets a value indicating whether the <see
cref="Apache.Avalon.Framework.Configuration.IConfiguration"/> is read-only.
/// </summary>
/// <value>
- /// <see langword="true"> if the <see cref="IConfiguration"/> is
read-only;
- /// otherwise, <see langword="false">.
+ /// <see langword="true"/> if the <see
cref="Apache.Avalon.Framework.Configuration.IConfiguration"/> is read-only;
+ /// otherwise, <see langword="false"/>.
/// </value>
public bool IsReadOnly
{
@@ -85,10 +85,10 @@
}
/// <summary>
- /// Gets the name of the <see cref="IConfiguration"/>.
+ /// Gets the name of the <see
cref="Apache.Avalon.Framework.Configuration.IConfiguration"/>.
/// </summary>
/// <value>
- /// The Name of the <see cref="IConfiguration"/>.
+ /// The Name of the <see
cref="Apache.Avalon.Framework.Configuration.IConfiguration"/>.
/// </value>
public string Name
{
@@ -105,7 +105,7 @@
}
/// <summary>
- /// Gets a string describing location of the <see
cref="IConfiguration"/>.
+ /// Gets a string describing location of the <see
cref="Apache.Avalon.Framework.Configuration.IConfiguration"/>.
/// </summary>
/// <value>
/// A String describing location of the <see cref="IConfiguration"/>.
@@ -125,10 +125,10 @@
}
/// <summary>
- /// Gets the value of <see cref="IConfiguration"/>.
+ /// Gets the value of <see
cref="Apache.Avalon.Framework.Configuration.IConfiguration"/>.
/// </summary>
/// <value>
- /// The Value of the <see cref="IConfiguration"/>.
+ /// The Value of the <see
cref="Apache.Avalon.Framework.Configuration.IConfiguration"/>.
/// </value>
public string Value
{
@@ -145,10 +145,10 @@
}
/// <summary>
- /// Gets the namespace of the <see cref="IConfiguration"/>.
+ /// Gets the namespace of the <see
cref="Apache.Avalon.Framework.Configuration.IConfiguration"/>.
/// </summary>
/// <value>
- /// The Namespace of the <see cref="IConfiguration"/>.
+ /// The Namespace of the <see
cref="Apache.Avalon.Framework.Configuration.IConfiguration"/>.
/// </value>
public string Namespace
{
@@ -166,10 +166,10 @@
}
/// <summary>
- /// Gets the prefix of the <see cref="IConfiguration"/>.
+ /// Gets the prefix of the <see
cref="Apache.Avalon.Framework.Configuration.IConfiguration"/>.
/// </summary>
/// <value>
- /// The prefix of the <see cref="IConfiguration"/>.
+ /// The prefix of the <see
cref="Apache.Avalon.Framework.Configuration.IConfiguration"/>.
/// </value>
public string Prefix
{
@@ -190,7 +190,7 @@
/// <summary>
/// Gets all child nodes.
/// </summary>
- /// <value>The <see cref="ConfigurationCollection"/> of child
nodes.</value>
+ /// <value>The <see
cref="Apache.Avalon.Framework.Configuration.ConfigurationCollection"/> of child
nodes.</value>
public ConfigurationCollection Children
{
get
@@ -238,12 +238,12 @@
}
/// <summary>
- /// Gets a <see cref="IConfiguration"/> instance encapsulating the
specified
+ /// Gets a <see
cref="Apache.Avalon.Framework.Configuration.IConfiguration"/> instance encapsulating
the specified
/// child node.
/// </summary>
/// <param name="child">The Name of the child node.</param>
/// <returns>
- /// The <see cref="IConfiguration"/> instance encapsulating the
specified
+ /// The <see
cref="Apache.Avalon.Framework.Configuration.IConfiguration"/> instance encapsulating
the specified
/// child node.
/// </returns>
public IConfiguration GetChild(string child)
@@ -252,18 +252,18 @@
}
/// <summary>
- /// Gets a <see cref="IConfiguration"/> instance encapsulating the
specified
+ /// Gets a <see
cref="Apache.Avalon.Framework.Configuration.IConfiguration"/> instance encapsulating
the specified
/// child node.
/// </summary>
/// <param name="child">The Name of the child node.</param>
/// <param name="createNew">
- /// If <see langword="true"/>, a new <see cref="IConfiguration"/>
+ /// If <see langword="true"/>, a new <see
cref="Apache.Avalon.Framework.Configuration.IConfiguration"/>
/// will be created and returned if the specified child does not exist.
/// If <see langword="false"/>, <see langword="null"/> will be
returned when the specified
/// child doesn't exist.
/// </param>
/// <returns>
- /// The <see cref="IConfiguration"/> instance encapsulating the
specified
+ /// The <see
cref="Apache.Avalon.Framework.Configuration.IConfiguration"/> instance encapsulating
the specified
/// child node.
/// </returns>
public abstract IConfiguration GetChild(string child, bool createNew);
@@ -350,7 +350,7 @@
/// <summary>
/// Check whether this node is readonly or not.
/// </summary>
- /// <exception cref="ConfigurationException">
+ /// <exception
cref="Apache.Avalon.Framework.Configuration.ConfigurationException">
/// If this node is readonly then an exception will be thrown.
/// </exception>
protected void CheckReadOnly()
1.8 +3 -3 avalon-sandbox/csframework/src/cs/Configuration/IConfigurable.cs
Index: IConfigurable.cs
===================================================================
RCS file:
/home/cvs/avalon-sandbox/csframework/src/cs/Configuration/IConfigurable.cs,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- IConfigurable.cs 24 Jun 2003 12:18:24 -0000 1.7
+++ IConfigurable.cs 24 Jun 2003 21:16:06 -0000 1.8
@@ -56,13 +56,13 @@
/// </summary>
/// <remarks>
/// The contract surrounding a <see cref="IConfigurable"/> is that the
- /// instantiating entity must call the <see
cref="IConfigurable.Configure(IConfiguration configuration)"/>
+ /// instantiating entity must call the <see cref="IConfigurable.Configure(
IConfiguration )"/>
/// method before it is valid.
- /// The <see cref="IConfigurable.Configure(IConfiguration configuration)"/>
method
+ /// The <see cref="IConfigurable.Configure( IConfiguration )"/> method
/// must be called after the constructor, and before any other method.
/// </remarks>
/// <remarks>
- /// Note that this interface is incompatible with <see
cref="Apache.Avalon.Parameter.IParameterizable"/>.
+ /// Note that this interface is incompatible with <see
cref="Apache.Avalon.Framework.Parameter.IParameterizable"/>.
/// </remarks>
public interface IConfigurable
{
1.9 +12 -12
avalon-sandbox/csframework/src/cs/Configuration/IConfiguration.cs
Index: IConfiguration.cs
===================================================================
RCS file:
/home/cvs/avalon-sandbox/csframework/src/cs/Configuration/IConfiguration.cs,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- IConfiguration.cs 24 Jun 2003 12:18:24 -0000 1.8
+++ IConfiguration.cs 24 Jun 2003 21:16:06 -0000 1.9
@@ -52,7 +52,7 @@
namespace Apache.Avalon.Framework.Configuration
{
/// <summary>
- /// <see cref="IConfiguration"/> is a interface encapsulating a configuration
node
+ /// <see cref="Apache.Avalon.Framework.Configuration.IConfiguration"/> is a
interface encapsulating a configuration node
/// used to retrieve configuration values.
/// </summary>
public interface IConfiguration
@@ -69,10 +69,10 @@
}
/// <summary>
- /// Gets a string describing location of <see cref="IConfiguration"/>.
+ /// Gets a string describing location of <see
cref="Apache.Avalon.Framework.Configuration.IConfiguration"/>.
/// </summary>
/// <value>
- /// A String describing location of <see cref="IConfiguration"/>.
+ /// A String describing location of <see
cref="Apache.Avalon.Framework.Configuration.IConfiguration"/>.
/// </value>
string Location
{
@@ -113,10 +113,10 @@
}
/// <summary>
- /// Gets a value indicating whether the <see cref="IConfiguration"/>
is read-only.
+ /// Gets a value indicating whether the <see
cref="Apache.Avalon.Framework.Configuration.IConfiguration"/> is read-only.
/// </summary>
/// <value>
- /// <see langword="true"/> if the <see cref="IConfiguration"/> is
read-only; otherwise, <see langword="false"/>.
+ /// <see langword="true"/> if the <see
cref="Apache.Avalon.Framework.Configuration.IConfiguration"/> is read-only; otherwise,
<see langword="false"/>.
/// </value>
bool IsReadOnly
{
@@ -124,7 +124,7 @@
}
/// <summary>
- /// Gets an <see cref="ConfigurationCollection"/> of <see
cref="IConfiguration"/>
+ /// Gets an <see
cref="Apache.Avalon.Framework.Configuration.ConfigurationCollection"/> of <see
cref="Apache.Avalon.Framework.Configuration.IConfiguration"/>
/// elements containing all node children.
/// </summary>
/// <value>The Collection of child nodes.</value>
@@ -142,29 +142,29 @@
}
/// <summary>
- /// Gets a <see cref="IConfiguration"/> instance encapsulating the
specified
+ /// Gets a <see
cref="Apache.Avalon.Framework.Configuration.IConfiguration"/> instance encapsulating
the specified
/// child node.
/// </summary>
/// <param name="child">The Name of the child node.</param>
/// <param name="createNew">
- /// If <see langword="true"/>, a new <see cref="IConfiguration"/>
+ /// If <see langword="true"/>, a new <see
cref="Apache.Avalon.Framework.Configuration.IConfiguration"/>
/// will be created and returned if the specified child does not exist.
/// If <see langword="false"/>, <see langword="null"/> will be
returned when the specified
/// child doesn't exist.
/// </param>
/// <returns>
- /// The <see cref="IConfiguration"/> instance encapsulating the
specified child node.
+ /// The <see
cref="Apache.Avalon.Framework.Configuration.IConfiguration"/> instance encapsulating
the specified child node.
/// </returns>
IConfiguration GetChild(string child, bool createNew);
/// <summary>
- /// Return an <see cref="ConfigurationCollection"/> of <see
cref="IConfiguration"/>
+ /// Return an <see
cref="Apache.Avalon.Framework.Configuration.ConfigurationCollection"/> of <see
cref="IConfiguration"/>
/// elements containing all node children with the specified name.
/// </summary>
/// <param name="name">The Name of the children to get.</param>
/// <returns>
- /// The <see cref="ConfigurationCollection"/> of
- /// <see cref="IConfiguration"/> children of
+ /// The <see
cref="Apache.Avalon.Framework.Configuration.ConfigurationCollection"/> of
+ /// <see cref="Apache.Avalon.Framework.Configuration.IConfiguration"/>
children of
/// this associated with the given name.
/// </returns>
ConfigurationCollection GetChildren(string name);
1.7 +16 -1 avalon-sandbox/csframework/src/cs/Logger/ConsoleLogger.cs
Index: ConsoleLogger.cs
===================================================================
RCS file: /home/cvs/avalon-sandbox/csframework/src/cs/Logger/ConsoleLogger.cs,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- ConsoleLogger.cs 24 Jun 2003 12:18:25 -0000 1.6
+++ ConsoleLogger.cs 24 Jun 2003 21:16:06 -0000 1.7
@@ -62,6 +62,9 @@
/// </summary>
public const int LEVEL_DEBUG = 0;
+ /// <summary>
+ /// String name for debug level messages.
+ /// </summary>
public const string LEVEL_DEBUG_NAME = "DEBUG";
/// <summary>
@@ -69,6 +72,9 @@
/// </summary>
public const int LEVEL_INFO = 1;
+ /// <summary>
+ /// String name for info level messages.
+ /// </summary>
public const string LEVEL_INFO_NAME = "INFO";
/// <summary>
@@ -76,6 +82,9 @@
/// </summary>
public const int LEVEL_WARN = 2;
+ /// <summary>
+ /// String name for warn level messages.
+ /// </summary>
public const string LEVEL_WARN_NAME = "WARN";
/// <summary>
@@ -83,6 +92,9 @@
/// </summary>
public const int LEVEL_ERROR = 3;
+ /// <summary>
+ /// String name for error level messages.
+ /// </summary>
public const string LEVEL_ERROR_NAME = "ERROR";
/// <summary>
@@ -90,6 +102,9 @@
/// </summary>
public const int LEVEL_FATAL = 4;
+ /// <summary>
+ /// String name for fatal error level messages.
+ /// </summary>
public const string LEVEL_FATAL_NAME = "FATAL ERROR";
/// <summary>
@@ -301,4 +316,4 @@
return this;
}
}
-}
\ No newline at end of file
+}
1.9 +2 -1 avalon-sandbox/csframework/src/cs/Logger/Log4netLogger.cs
Index: Log4netLogger.cs
===================================================================
RCS file: /home/cvs/avalon-sandbox/csframework/src/cs/Logger/Log4netLogger.cs,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- Log4netLogger.cs 24 Jun 2003 17:38:29 -0000 1.8
+++ Log4netLogger.cs 24 Jun 2003 21:16:06 -0000 1.9
@@ -64,7 +64,8 @@
/// <summary>
/// Creates a m_logger that delegates to specified category.
/// </summary>
- /// <param name="logImpl">The Category to delegate to.</param>
+ /// <param name="logImpl">The ILog to delegate to.</param>
+ /// <param name="name">The current category name.</param>
public Log4netLogger(ILog logImpl, string name)
{
m_logger = logImpl;
1.8 +2 -2 avalon-sandbox/csframework/src/cs/Parameters/IParameterizable.cs
Index: IParameterizable.cs
===================================================================
RCS file:
/home/cvs/avalon-sandbox/csframework/src/cs/Parameters/IParameterizable.cs,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- IParameterizable.cs 24 Jun 2003 12:18:26 -0000 1.7
+++ IParameterizable.cs 24 Jun 2003 21:16:06 -0000 1.8
@@ -54,8 +54,8 @@
/// Components should implement this interface if they wish to
/// be provided with parameters during startup. This interface
/// will be called after IComposable.Compose(...) method and before
- /// <see cref="Apache.Avalon.Activity.IInitializable.Initialize()"/>.
- /// It is incompatible with the <see
cref="Apache.Avalon.Configuration.IConfigurable"/> interface.
+ /// <see cref="Apache.Avalon.Framework.Activity.IInitializable.Initialize()"/>.
+ /// It is incompatible with the <see
cref="Apache.Avalon.Framework.Configuration.IConfigurable"/> interface.
/// </summary>
public interface IParameterizable
{
1.12 +7 -0 avalon-sandbox/csframework/src/cs/Parameters/Parameters.cs
Index: Parameters.cs
===================================================================
RCS file: /home/cvs/avalon-sandbox/csframework/src/cs/Parameters/Parameters.cs,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- Parameters.cs 24 Jun 2003 12:18:26 -0000 1.11
+++ Parameters.cs 24 Jun 2003 21:16:07 -0000 1.12
@@ -231,6 +231,9 @@
readOnly = true;
}
+ /// <summary>
+ /// Ensure that we are not trying to modify a read-only Parameters
object.
+ /// </summary>
protected void CheckReadOnly()
{
if( IsReadOnly )
@@ -263,6 +266,10 @@
return parameters.GetEnumerator();
}
+ /// <summary>
+ /// Returns the number of parameters available.
+ /// </summary>
+ /// <returns>the integer number of parameters</returns>
public int Count
{
get
1.8 +12 -1
avalon-sandbox/csframework/src/cs/Service/DefaultServiceManager.cs
Index: DefaultServiceManager.cs
===================================================================
RCS file:
/home/cvs/avalon-sandbox/csframework/src/cs/Service/DefaultServiceManager.cs,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- DefaultServiceManager.cs 24 Jun 2003 12:18:26 -0000 1.7
+++ DefaultServiceManager.cs 24 Jun 2003 21:16:07 -0000 1.8
@@ -173,11 +173,18 @@
// returned to the pool here.
}
+ /// <summary>
+ /// Make this <see cref="IServiceManager"/> immutable
+ /// </summary>
public void MakeReadOnly()
{
readOnly = true;
}
+ /// <summary>
+ /// Ensure that we are not trying to modify a read-only
+ /// <see cref="DefaultServiceManager"/>.
+ /// </summary>
protected void CheckReadOnly()
{
if( IsReadOnly )
@@ -186,6 +193,10 @@
}
}
+ /// <summary>
+ /// Get the enumerator for child components.
+ /// </summary>
+ /// <returns>The <see cref="IEnumerator"/> for the child
components.</returns>
public IEnumerator GetEnumerator()
{
return components.GetEnumerator();
@@ -210,4 +221,4 @@
return buffer.ToString();
}
}
-}
\ No newline at end of file
+}
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
