nicko 2004/05/30 04:38:00
Modified: src LogManager.cs
Log:
Updated doc comments.
Marked WrapLogger and WrapLoggers as private methods.
Revision Changes Path
1.5 +16 -10 logging-log4net/src/LogManager.cs
Index: LogManager.cs
===================================================================
RCS file: /home/cvs/logging-log4net/src/LogManager.cs,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- LogManager.cs 21 May 2004 22:15:32 -0000 1.4
+++ LogManager.cs 30 May 2004 11:38:00 -0000 1.5
@@ -32,12 +32,6 @@
/// <para>
/// See the <see cref="ILog"/> interface for more details.
/// </para>
- /// <para>
- /// log4net uses NUnit 2.0 to provide internal unit testing.
- /// To run the tests you will need a copy of NUnit 2.0. Then
- /// run the following command:
- /// </para>
- /// <code>nunit-console.exe /assembly:<log4net assembly></code>
/// </remarks>
/// <example>Simple example of logging messages
/// <code>
@@ -113,6 +107,13 @@
/// <summary>
/// Returns the named logger if it exists.
/// </summary>
+ /// <remarks>
+ /// <para>
+ /// If the named logger exists (in the repository for the
specified assembly) then it
+ /// returns a reference to the logger, otherwise it returns
+ /// <c>null</c>.
+ /// </para>
+ /// </remarks>
/// <param name="repositoryAssembly">The assembly to use to
lookup the repository.</param>
/// <param name="name">The fully qualified logger name to look
for.</param>
/// <returns>
@@ -673,12 +674,12 @@
/// specified such that a call to <see
cref="GetRepository(Assembly)"/> with the
/// same assembly specified will return the same repository
instance.
/// </para>
+ /// </remarks>
/// <param name="repositoryAssembly">The assembly to use to get
the name of the repository.</param>
/// <param name="repositoryType">A <see cref="Type"/> that
implements <see cref="ILoggerRepository"/>
/// and has a no arg constructor. An instance of this type will
be created to act
/// as the <see cref="ILoggerRepository"/> for the repository
specified.</param>
/// <returns>The <see cref="ILoggerRepository"/> created for
the repository.</returns>
- /// </remarks>
[Obsolete("Use CreateRepository instead of CreateDomain")]
public static ILoggerRepository CreateDomain(Assembly
repositoryAssembly, Type repositoryType)
{
@@ -694,12 +695,12 @@
/// specified such that a call to <see
cref="GetRepository(Assembly)"/> with the
/// same assembly specified will return the same repository
instance.
/// </para>
+ /// </remarks>
/// <param name="repositoryAssembly">The assembly to use to get
the name of the repository.</param>
/// <param name="repositoryType">A <see cref="Type"/> that
implements <see cref="ILoggerRepository"/>
/// and has a no arg constructor. An instance of this type will
be created to act
/// as the <see cref="ILoggerRepository"/> for the repository
specified.</param>
/// <returns>The <see cref="ILoggerRepository"/> created for
the repository.</returns>
- /// </remarks>
public static ILoggerRepository CreateRepository(Assembly
repositoryAssembly, Type repositoryType)
{
return
LoggerManager.CreateRepository(repositoryAssembly, repositoryType);
@@ -708,6 +709,11 @@
/// <summary>
/// Gets the list of currently defined repositories.
/// </summary>
+ /// <remarks>
+ /// <para>
+ /// Get an array of all the <see cref="ILoggerRepository"/>
objects that have been created.
+ /// </para>
+ /// </remarks>
/// <returns>An array of all the known <see
cref="ILoggerRepository"/> objects.</returns>
public static ILoggerRepository[] GetAllRepositories()
{
@@ -723,7 +729,7 @@
/// </summary>
/// <param name="logger">The logger to get the wrapper
for.</param>
/// <returns>The wrapper for the logger specified.</returns>
- public static ILog WrapLogger(ILogger logger)
+ private static ILog WrapLogger(ILogger logger)
{
return (ILog)s_wrapperMap[logger];
}
@@ -733,7 +739,7 @@
/// </summary>
/// <param name="loggers">The loggers to get the wrappers
for.</param>
/// <returns>The wrapper objects for the loggers
specified.</returns>
- public static ILog[] WrapLoggers(ILogger[] loggers)
+ private static ILog[] WrapLoggers(ILogger[] loggers)
{
ILog[] results = new ILog[loggers.Length];
for(int i=0; i<loggers.Length; i++)
