nicko 2004/11/22 17:37:29
Modified: src/Config AliasDomainAttribute.cs
AliasRepositoryAttribute.cs BasicConfigurator.cs
ConfiguratorAttribute.cs DOMConfigurator.cs
DomainAttribute.cs
Log4NetConfigurationSectionHandler.cs
PluginAttribute.cs RepositoryAttribute.cs
XmlConfigurator.cs XmlConfiguratorAttribute.cs
Log:
Updated doc comments
Revision Changes Path
1.5 +5 -0 logging-log4net/src/Config/AliasDomainAttribute.cs
Index: AliasDomainAttribute.cs
===================================================================
RCS file: /home/cvs/logging-log4net/src/Config/AliasDomainAttribute.cs,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- AliasDomainAttribute.cs 21 May 2004 22:15:32 -0000 1.4
+++ AliasDomainAttribute.cs 23 Nov 2004 01:37:29 -0000 1.5
@@ -57,6 +57,11 @@
/// the specified domain to alias to this assembly's repository.
/// </summary>
/// <param name="name">The domain to alias to this assemby's
repository.</param>
+ /// <remarks>
+ /// <para>
+ /// Obsolete. Use <see cref="AliasRepositoryAttribute"/>
instead of <see cref="AliasDomainAttribute"/>.
+ /// </para>
+ /// </remarks>
public AliasDomainAttribute(string name) : base(name)
{
}
1.5 +11 -0 logging-log4net/src/Config/AliasRepositoryAttribute.cs
Index: AliasRepositoryAttribute.cs
===================================================================
RCS file: /home/cvs/logging-log4net/src/Config/AliasRepositoryAttribute.cs,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- AliasRepositoryAttribute.cs 21 May 2004 22:15:32 -0000 1.4
+++ AliasRepositoryAttribute.cs 23 Nov 2004 01:37:29 -0000 1.5
@@ -57,6 +57,12 @@
/// the specified repository to alias to this assembly's
repository.
/// </summary>
/// <param name="name">The repository to alias to this
assemby's repository.</param>
+ /// <remarks>
+ /// <para>
+ /// Initializes a new instance of the <see
cref="AliasRepositoryAttribute" /> class with
+ /// the specified repository to alias to this assembly's
repository.
+ /// </para>
+ /// </remarks>
public AliasRepositoryAttribute(string name)
{
Name = name;
@@ -72,6 +78,11 @@
/// <value>
/// The repository to alias to this assemby's repository.
/// </value>
+ /// <remarks>
+ /// <para>
+ /// The name of the repository to alias to this assemby's
repository.
+ /// </para>
+ /// </remarks>
public string Name
{
get { return m_name; }
1.6 +12 -0 logging-log4net/src/Config/BasicConfigurator.cs
Index: BasicConfigurator.cs
===================================================================
RCS file: /home/cvs/logging-log4net/src/Config/BasicConfigurator.cs,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- BasicConfigurator.cs 1 Jun 2004 18:28:14 -0000 1.5
+++ BasicConfigurator.cs 23 Nov 2004 01:37:29 -0000 1.6
@@ -54,7 +54,9 @@
/// Initializes a new instance of the <see
cref="BasicConfigurator" /> class.
/// </summary>
/// <remarks>
+ /// <para>
/// Uses a private access modifier to prevent instantiation of
this class.
+ /// </para>
/// </remarks>
private BasicConfigurator()
{
@@ -85,6 +87,11 @@
/// Initializes the log4net system using the specified appender.
/// </summary>
/// <param name="appender">The appender to use to log all
logging events.</param>
+ /// <remarks>
+ /// <para>
+ /// Initializes the log4net system using the specified appender.
+ /// </para>
+ /// </remarks>
static public void Configure(IAppender appender)
{
BasicConfigurator.Configure(LogManager.GetRepository(Assembly.GetCallingAssembly()),
appender);
@@ -123,6 +130,11 @@
/// </summary>
/// <param name="repository">The repository to
configure.</param>
/// <param name="appender">The appender to use to log all
logging events.</param>
+ /// <remarks>
+ /// <para>
+ /// Initializes the <see cref="ILoggerRepository"/> using the
specified appender.
+ /// </para>
+ /// </remarks>
static public void Configure(ILoggerRepository repository,
IAppender appender)
{
if (repository is IBasicRepositoryConfigurator)
1.7 +6 -0 logging-log4net/src/Config/ConfiguratorAttribute.cs
Index: ConfiguratorAttribute.cs
===================================================================
RCS file: /home/cvs/logging-log4net/src/Config/ConfiguratorAttribute.cs,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- ConfiguratorAttribute.cs 15 Nov 2004 02:51:46 -0000 1.6
+++ ConfiguratorAttribute.cs 23 Nov 2004 01:37:29 -0000 1.7
@@ -63,6 +63,12 @@
/// </summary>
/// <param name="sourceAssembly">The assembly that this
attribute was defined on.</param>
/// <param name="targetRepository">The repository to
configure.</param>
+ /// <remarks>
+ /// <para>
+ /// Abstract method implemented by a subclass. When this method
is called
+ /// the subclass should configure the <paramref
name="targetRepository"/>.
+ /// </para>
+ /// </remarks>
public abstract void Configure(Assembly sourceAssembly,
ILoggerRepository targetRepository);
/// <summary>
1.5 +12 -12 logging-log4net/src/Config/DOMConfigurator.cs
Index: DOMConfigurator.cs
===================================================================
RCS file: /home/cvs/logging-log4net/src/Config/DOMConfigurator.cs,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- DOMConfigurator.cs 21 May 2004 22:15:32 -0000 1.4
+++ DOMConfigurator.cs 23 Nov 2004 01:37:29 -0000 1.5
@@ -169,12 +169,12 @@
/// <para>
/// In the <c>.config</c> file, the path to the log4net can be
specified like this :
/// </para>
- /// <code>
- /// <configuration>
- /// <appSettings>
- /// <add key="log4net-config-file"
value="log.config"/>
- /// </appSettings>
- /// </configuration>
+ /// <code lang="XML" escaped="true">
+ /// <configuration>
+ /// <appSettings>
+ /// <add key="log4net-config-file"
value="log.config"/>
+ /// </appSettings>
+ /// </configuration>
/// </code>
/// </remarks>
[Obsolete("Use XmlConfigurator.Configure instead of
DOMConfigurator.Configure")]
@@ -242,12 +242,12 @@
/// <para>
/// In the <c>.config</c> file, the path to the log4net can be
specified like this :
/// </para>
- /// <code>
- /// <configuration>
- /// <appSettings>
- /// <add key="log4net-config-file"
value="log.config"/>
- /// </appSettings>
- /// </configuration>
+ /// <code lang="XML" escaped="true">
+ /// <configuration>
+ /// <appSettings>
+ /// <add key="log4net-config-file"
value="log.config"/>
+ /// </appSettings>
+ /// </configuration>
/// </code>
/// </remarks>
[Obsolete("Use XmlConfigurator.Configure instead of
DOMConfigurator.Configure")]
1.5 +10 -0 logging-log4net/src/Config/DomainAttribute.cs
Index: DomainAttribute.cs
===================================================================
RCS file: /home/cvs/logging-log4net/src/Config/DomainAttribute.cs,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- DomainAttribute.cs 21 May 2004 22:15:32 -0000 1.4
+++ DomainAttribute.cs 23 Nov 2004 01:37:29 -0000 1.5
@@ -56,6 +56,11 @@
/// <summary>
/// Initializes a new instance of the <see
cref="DomainAttribute" /> class.
/// </summary>
+ /// <remarks>
+ /// <para>
+ /// Obsolete. Use RepositoryAttribute instead of
DomainAttribute.
+ /// </para>
+ /// </remarks>
public DomainAttribute() : base()
{
}
@@ -65,6 +70,11 @@
/// with the name of the domain.
/// </summary>
/// <param name="name">The name of the domain.</param>
+ /// <remarks>
+ /// <para>
+ /// Obsolete. Use RepositoryAttribute instead of
DomainAttribute.
+ /// </para>
+ /// </remarks>
public DomainAttribute(string name) : base(name)
{
}
1.4 +18 -9
logging-log4net/src/Config/Log4NetConfigurationSectionHandler.cs
Index: Log4NetConfigurationSectionHandler.cs
===================================================================
RCS file:
/home/cvs/logging-log4net/src/Config/Log4NetConfigurationSectionHandler.cs,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Log4NetConfigurationSectionHandler.cs 21 May 2004 22:15:32 -0000
1.3
+++ Log4NetConfigurationSectionHandler.cs 23 Nov 2004 01:37:29 -0000
1.4
@@ -34,16 +34,15 @@
/// </remarks>
/// <example>
/// Example of registering the log4net section handler :
- /// <code>
- /// <?xml version="1.0" encoding="utf-8" ?>
- /// <configuration>
- /// <configSections>
- /// <section name="log4net"
type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" />
- /// </configSections>
- /// <log4net>
+ /// <code lang="XML" escaped="true">
+ /// <configuration>
+ /// <configSections>
+ /// <section name="log4net"
type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" />
+ /// </configSections>
+ /// <log4net>
/// log4net configuration XML goes here
- /// </log4net>
- /// </configuration>
+ /// </log4net>
+ /// </configuration>
/// </code>
/// </example>
/// <author>Nicko Cadell</author>
@@ -55,6 +54,11 @@
/// <summary>
/// Initializes a new instance of the <see
cref="Log4NetConfigurationSectionHandler"/> class.
/// </summary>
+ /// <remarks>
+ /// <para>
+ /// Default constructor.
+ /// </para>
+ /// </remarks>
public Log4NetConfigurationSectionHandler()
{
}
@@ -70,6 +74,11 @@
/// <param name="configContext">The configuration context when
called from the ASP.NET configuration system. Otherwise, this parameter is
reserved and is a null reference.</param>
/// <param name="section">The <see cref="XmlNode" /> for the
log4net section.</param>
/// <returns>The <see cref="XmlNode" /> for the log4net
section.</returns>
+ /// <remarks>
+ /// <para>
+ /// Returns the <see cref="XmlNode"/> containing the
configuration data,
+ /// </para>
+ /// </remarks>
public object Create(object parent, object configContext,
XmlNode section)
{
return section;
1.5 +21 -0 logging-log4net/src/Config/PluginAttribute.cs
Index: PluginAttribute.cs
===================================================================
RCS file: /home/cvs/logging-log4net/src/Config/PluginAttribute.cs,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- PluginAttribute.cs 1 Oct 2004 21:02:16 -0000 1.4
+++ PluginAttribute.cs 23 Nov 2004 01:37:29 -0000 1.5
@@ -33,6 +33,13 @@
/// Assembly level attribute that specifies a plugin to attach to
/// the repository.
/// </summary>
+ /// <remarks>
+ /// <para>
+ /// Specifies the type of a plugin to create and attach to the
+ /// assembly's repository. The plugin type must implement the
+ /// <see cref="IPlugin"/> interface.
+ /// </para>
+ /// </remarks>
/// <author>Nicko Cadell</author>
/// <author>Gert Driesen</author>
[AttributeUsage(AttributeTargets.Assembly,AllowMultiple=true)]
@@ -46,6 +53,11 @@
/// with the specified type.
/// </summary>
/// <param name="type">The type of plugin to create.</param>
+ /// <remarks>
+ /// <para>
+ /// Create the attribute with the plugin type specified.
+ /// </para>
+ /// </remarks>
public PluginAttribute(string type)
{
m_type = type;
@@ -61,6 +73,11 @@
/// <value>
/// The type name for the plugin.
/// </value>
+ /// <remarks>
+ /// <para>
+ /// The type name for the plugin.
+ /// </para>
+ /// </remarks>
public string Type
{
get { return m_type; }
@@ -75,8 +92,10 @@
/// Creates the plugin object defined by this attribute.
/// </summary>
/// <remarks>
+ /// <para>
/// Creates the instance of the <see cref="IPlugin"/> object as
/// specified by this attribute.
+ /// </para>
/// </remarks>
/// <returns>The plugin object.</returns>
public IPlugin CreatePlugin()
@@ -104,8 +123,10 @@
/// Returns a representation of the properties of this object.
/// </summary>
/// <remarks>
+ /// <para>
/// Overrides base class <see cref="Object.ToString()" />
method to
/// return a representation of the properties of this object.
+ /// </para>
/// </remarks>
/// <returns>A representation of the properties of this
object</returns>
override public string ToString()
1.5 +12 -0 logging-log4net/src/Config/RepositoryAttribute.cs
Index: RepositoryAttribute.cs
===================================================================
RCS file: /home/cvs/logging-log4net/src/Config/RepositoryAttribute.cs,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- RepositoryAttribute.cs 21 May 2004 22:15:32 -0000 1.4
+++ RepositoryAttribute.cs 23 Nov 2004 01:37:29 -0000 1.5
@@ -56,6 +56,11 @@
/// <summary>
/// Initializes a new instance of the <see
cref="RepositoryAttribute" /> class.
/// </summary>
+ /// <remarks>
+ /// <para>
+ /// Default constructor.
+ /// </para>
+ /// </remarks>
public RepositoryAttribute()
{
}
@@ -65,6 +70,11 @@
/// with the name of the repository.
/// </summary>
/// <param name="name">The name of the repository.</param>
+ /// <remarks>
+ /// <para>
+ /// Initialize the attribute with the name for the assembly's
repository.
+ /// </para>
+ /// </remarks>
public RepositoryAttribute(string name)
{
m_name = name;
@@ -82,8 +92,10 @@
/// assembly.
/// </value>
/// <remarks>
+ /// <para>
/// This value does not have to be unique. Several assemblies
can share the
/// same repository. They will share the logging configuration
of the repository.
+ /// </para>
/// </remarks>
public string Name
{
1.8 +39 -24 logging-log4net/src/Config/XmlConfigurator.cs
Index: XmlConfigurator.cs
===================================================================
RCS file: /home/cvs/logging-log4net/src/Config/XmlConfigurator.cs,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- XmlConfigurator.cs 10 Sep 2004 09:15:44 -0000 1.7
+++ XmlConfigurator.cs 23 Nov 2004 01:37:29 -0000 1.8
@@ -33,7 +33,9 @@
/// Use this class to initialize the log4net environment using an Xml
tree.
/// </summary>
/// <remarks>
+ /// <para>
/// Configures a <see cref="ILoggerRepository"/> using an Xml tree.
+ /// </para>
/// </remarks>
/// <author>Nicko Cadell</author>
/// <author>Gert Driesen</author>
@@ -183,8 +185,10 @@
/// Configures log4net using a <c>log4net</c> element
/// </summary>
/// <remarks>
+ /// <para>
/// Loads the log4net configuration from the XML element
/// supplied as <paramref name="element"/>.
+ /// </para>
/// </remarks>
/// <param name="element">The element to parse.</param>
static public void Configure(XmlElement element)
@@ -252,12 +256,12 @@
/// <para>
/// In the <c>.config</c> file, the path to the log4net can be
specified like this :
/// </para>
- /// <code>
- /// <configuration>
- /// <appSettings>
- /// <add key="log4net-config-file"
value="log.config"/>
- /// </appSettings>
- /// </configuration>
+ /// <code lang="XML" escaped="true">
+ /// <configuration>
+ /// <appSettings>
+ /// <add key="log4net-config-file"
value="log.config"/>
+ /// </appSettings>
+ /// </configuration>
/// </code>
/// </remarks>
#else
@@ -287,12 +291,12 @@
/// <para>
/// In the <c>.config</c> file, the path to the log4net can be
specified like this :
/// </para>
- /// <code>
- /// <configuration>
- /// <appSettings>
- /// <add key="log4net-config-file"
value="log.config"/>
- /// </appSettings>
- /// </configuration>
+ /// <code lang="XML" escaped="true">
+ /// <configuration>
+ /// <appSettings>
+ /// <add key="log4net-config-file"
value="log.config"/>
+ /// </appSettings>
+ /// </configuration>
/// </code>
/// </remarks>
#endif
@@ -365,12 +369,12 @@
/// <para>
/// In the <c>.config</c> file, the path to the log4net can be
specified like this :
/// </para>
- /// <code>
- /// <configuration>
- /// <appSettings>
- /// <add key="log4net-config-file"
value="log.config"/>
- /// </appSettings>
- /// </configuration>
+ /// <code lang="XML" escaped="true">
+ /// <configuration>
+ /// <appSettings>
+ /// <add key="log4net-config-file"
value="log.config"/>
+ /// </appSettings>
+ /// </configuration>
/// </code>
/// </remarks>
#else
@@ -402,12 +406,12 @@
/// <para>
/// In the <c>.config</c> file, the path to the log4net can be
specified like this :
/// </para>
- /// <code>
- /// <configuration>
- /// <appSettings>
- /// <add key="log4net-config-file"
value="log.config"/>
- /// </appSettings>
- /// </configuration>
+ /// <code lang="XML" escaped="true">
+ /// <configuration>
+ /// <appSettings>
+ /// <add key="log4net-config-file"
value="log.config"/>
+ /// </appSettings>
+ /// </configuration>
/// </code>
/// </remarks>
#endif
@@ -638,6 +642,7 @@
/// Class used to watch config files.
/// </summary>
/// <remarks>
+ /// <para>
/// Uses the <see cref="FileSystemWatcher"/> to monitor
/// changes to a specified file. Because multiple change
notifications
/// may be raised when the file is modified, a timer is used to
@@ -647,6 +652,7 @@
/// change notifications arrive while the timer is waiting it
/// is reset and waits again for <see cref="TimeoutMillis"/> to
/// elapse.
+ /// </para>
/// </remarks>
private sealed class ConfigureAndWatchHandler
{
@@ -676,6 +682,11 @@
/// </summary>
/// <param name="repository">The repository to
configure.</param>
/// <param name="configFile">The configuration file to
watch.</param>
+ /// <remarks>
+ /// <para>
+ /// Initializes a new instance of the <see
cref="ConfigureAndWatchHandler" /> class.
+ /// </para>
+ /// </remarks>
internal ConfigureAndWatchHandler(ILoggerRepository
repository, FileInfo configFile)
{
m_repository = repository;
@@ -709,7 +720,9 @@
/// <param name="source">The <see
cref="FileSystemWatcher"/> firing the event.</param>
/// <param name="e">The argument indicates the file
that caused the event to be fired.</param>
/// <remarks>
+ /// <para>
/// This handler reloads the configuration from the
file when the event is fired.
+ /// </para>
/// </remarks>
private void ConfigureAndWatchHandler_OnChanged(object
source, FileSystemEventArgs e)
{
@@ -726,7 +739,9 @@
/// <param name="source">The <see
cref="FileSystemWatcher"/> firing the event.</param>
/// <param name="e">The argument indicates the file
that caused the event to be fired.</param>
/// <remarks>
+ /// <para>
/// This handler reloads the configuration from the
file when the event is fired.
+ /// </para>
/// </remarks>
private void ConfigureAndWatchHandler_OnRenamed(object
source, RenamedEventArgs e)
{
1.7 +5 -0 logging-log4net/src/Config/XmlConfiguratorAttribute.cs
Index: XmlConfiguratorAttribute.cs
===================================================================
RCS file: /home/cvs/logging-log4net/src/Config/XmlConfiguratorAttribute.cs,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- XmlConfiguratorAttribute.cs 15 Nov 2004 02:51:46 -0000 1.6
+++ XmlConfiguratorAttribute.cs 23 Nov 2004 01:37:29 -0000 1.7
@@ -56,6 +56,11 @@
/// <summary>
/// Default constructor
/// </summary>
+ /// <remarks>
+ /// <para>
+ /// Default constructor
+ /// </para>
+ /// </remarks>
public XmlConfiguratorAttribute() : base(0) /* configurator
priority 0 */
{
}
