nicko 2005/02/13 19:45:23
Modified: src MDC.cs LogicalThreadContext.cs ThreadContext.cs
Log:
Updated doc comments
Revision Changes Path
1.8 +31 -5 logging-log4net/src/MDC.cs
Index: MDC.cs
===================================================================
RCS file: /home/cvs/logging-log4net/src/MDC.cs,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- MDC.cs 17 Jan 2005 20:18:40 -0000 1.7
+++ MDC.cs 14 Feb 2005 03:45:23 -0000 1.8
@@ -25,10 +25,12 @@
/// Implementation of Mapped Diagnostic Contexts.
/// </summary>
/// <remarks>
+ /// <note>
/// <para>
/// The MDC is deprecated and has been replaced by the <see
cref="ThreadContext.Properties"/>.
/// The current MDC implementation forwards to the
<c>ThreadContext.Properties</c>.
/// </para>
+ /// </note>
/// <para>
/// The MDC class is similar to the <see cref="NDC"/> class except that
it is
/// based on a map instead of a stack. It provides <i>mapped
@@ -66,14 +68,20 @@
/// <summary>
/// Gets the context value identified by the <paramref
name="key" /> parameter.
/// </summary>
+ /// <param name="key">The key to lookup in the MDC.</param>
+ /// <returns>The string value held for the key, or a
<c>null</c> reference if no corresponding value is found.</returns>
/// <remarks>
+ /// <note>
+ /// <para>
+ /// The MDC is deprecated and has been replaced by the <see
cref="ThreadContext.Properties"/>.
+ /// The current MDC implementation forwards to the
<c>ThreadContext.Properties</c>.
+ /// </para>
+ /// </note>
/// <para>
/// If the <paramref name="key" /> parameter does not look up
to a
/// previously defined context then <c>null</c> will be
returned.
/// </para>
/// </remarks>
- /// <param name="key">The key to lookup in the MDC.</param>
- /// <returns>The string value held for the key, or a
<c>null</c> reference if no corresponding value is found.</returns>
/*[Obsolete("MDC has been replaced by
ThreadContext.Properties")]*/
public static string Get(string key)
{
@@ -88,7 +96,15 @@
/// <summary>
/// Add an entry to the MDC
/// </summary>
+ /// <param name="key">The key to store the value under.</param>
+ /// <param name="value">The value to store.</param>
/// <remarks>
+ /// <note>
+ /// <para>
+ /// The MDC is deprecated and has been replaced by the <see
cref="ThreadContext.Properties"/>.
+ /// The current MDC implementation forwards to the
<c>ThreadContext.Properties</c>.
+ /// </para>
+ /// </note>
/// <para>
/// Puts a context value (the <paramref name="val" />
parameter) as identified
/// with the <paramref name="key" /> parameter into the current
thread's
@@ -100,8 +116,6 @@
/// is specified as <c>null</c> then the key value mapping will
be removed.
/// </para>
/// </remarks>
- /// <param name="key">The key to store the value under.</param>
- /// <param name="value">The value to store.</param>
/*[Obsolete("MDC has been replaced by
ThreadContext.Properties")]*/
public static void Set(string key, string value)
{
@@ -111,12 +125,18 @@
/// <summary>
/// Removes the key value mapping for the key specified.
/// </summary>
+ /// <param name="key">The key to remove.</param>
/// <remarks>
+ /// <note>
+ /// <para>
+ /// The MDC is deprecated and has been replaced by the <see
cref="ThreadContext.Properties"/>.
+ /// The current MDC implementation forwards to the
<c>ThreadContext.Properties</c>.
+ /// </para>
+ /// </note>
/// <para>
/// Remove the specified entry from this thread's MDC
/// </para>
/// </remarks>
- /// <param name="key">The key to remove.</param>
/*[Obsolete("MDC has been replaced by
ThreadContext.Properties")]*/
public static void Remove(string key)
{
@@ -127,6 +147,12 @@
/// Clear all entries in the MDC
/// </summary>
/// <remarks>
+ /// <note>
+ /// <para>
+ /// The MDC is deprecated and has been replaced by the <see
cref="ThreadContext.Properties"/>.
+ /// The current MDC implementation forwards to the
<c>ThreadContext.Properties</c>.
+ /// </para>
+ /// </note>
/// <para>
/// Remove all the entries from this thread's MDC
/// </para>
1.6 +4 -0 logging-log4net/src/LogicalThreadContext.cs
Index: LogicalThreadContext.cs
===================================================================
RCS file: /home/cvs/logging-log4net/src/LogicalThreadContext.cs,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- LogicalThreadContext.cs 14 Feb 2005 03:24:36 -0000 1.5
+++ LogicalThreadContext.cs 14 Feb 2005 03:45:23 -0000 1.6
@@ -77,7 +77,9 @@
/// Private Constructor.
/// </summary>
/// <remarks>
+ /// <para>
/// Uses a private access modifier to prevent instantiation of
this class.
+ /// </para>
/// </remarks>
private LogicalThreadContext()
{
@@ -94,8 +96,10 @@
/// The thread properties map
/// </value>
/// <remarks>
+ /// <para>
/// The <c>LogicalThreadContext</c> properties override any
<see cref="ThreadContext"/>
/// or <see cref="GlobalContext"/> properties with the same
name.
+ /// </para>
/// </remarks>
public static LogicalThreadContextProperties Properties
{
1.7 +4 -0 logging-log4net/src/ThreadContext.cs
Index: ThreadContext.cs
===================================================================
RCS file: /home/cvs/logging-log4net/src/ThreadContext.cs,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- ThreadContext.cs 14 Feb 2005 03:24:36 -0000 1.6
+++ ThreadContext.cs 14 Feb 2005 03:45:23 -0000 1.7
@@ -74,7 +74,9 @@
/// Private Constructor.
/// </summary>
/// <remarks>
+ /// <para>
/// Uses a private access modifier to prevent instantiation of
this class.
+ /// </para>
/// </remarks>
private ThreadContext()
{
@@ -91,8 +93,10 @@
/// The thread properties map
/// </value>
/// <remarks>
+ /// <para>
/// The <c>ThreadContext</c> properties override any <see
cref="GlobalContext"/>
/// properties with the same name.
+ /// </para>
/// </remarks>
public static ThreadContextProperties Properties
{
