nicko 2004/08/02 02:41:10
Modified: src GlobalContext.cs
Log:
Added code example
Revision Changes Path
1.2 +16 -3 logging-log4net/src/GlobalContext.cs
Index: GlobalContext.cs
===================================================================
RCS file: /home/cvs/logging-log4net/src/GlobalContext.cs,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- GlobalContext.cs 30 Jul 2004 17:42:35 -0000 1.1
+++ GlobalContext.cs 2 Aug 2004 09:41:10 -0000 1.2
@@ -28,10 +28,20 @@
/// </summary>
/// <remarks>
/// <para>
- /// The GlobalContext provides a global properties map. These
- /// properties can be included in the output of log messages.
+ /// The <c>GlobalContext</c> provides a location for global debugging
+ /// information to be stored.
+ /// </para>
+ /// <para>
+ /// The global context has a properties map and these properties can
+ /// be included in the output of log messages. The <see
cref="log4net.Layout.PatternLayout"/>
+ /// supports selecting and outputing these properties.
/// </para>
/// </remarks>
+ /// <example>
+ /// <code>
+ /// GlobalContext.Properties["hostname"] = Environment.MachineName;
+ /// </code>
+ /// </example>
/// <author>Nicko Cadell</author>
public sealed class GlobalContext
{
@@ -52,8 +62,11 @@
#region Public Static Properties
/// <summary>
- /// Get the global properties map
+ /// The global properties map
/// </summary>
+ /// <value>
+ /// The global properties map
+ /// </value>
public static GlobalContextProperties Properties
{
get { return s_properties; }
