Author: rgrabowski
Date: Thu Oct 12 08:09:59 2006
New Revision: 463269
URL: http://svn.apache.org/viewvc?view=rev&rev=463269
Log:
Added missing documentation for ASP.Net related PatternConverters. LOG4NET-87.
Modified:
logging/log4net/trunk/src/Layout/Pattern/AspNetCachePatternConverter.cs
logging/log4net/trunk/src/Layout/Pattern/AspNetContextPatternConverter.cs
logging/log4net/trunk/src/Layout/Pattern/AspNetPatternConverter.cs
logging/log4net/trunk/src/Layout/Pattern/AspNetRequestPatternConverter.cs
logging/log4net/trunk/src/Layout/Pattern/AspNetSessionPatternConverter.cs
Modified:
logging/log4net/trunk/src/Layout/Pattern/AspNetCachePatternConverter.cs
URL:
http://svn.apache.org/viewvc/logging/log4net/trunk/src/Layout/Pattern/AspNetCachePatternConverter.cs?view=diff&rev=463269&r1=463268&r2=463269
==============================================================================
--- logging/log4net/trunk/src/Layout/Pattern/AspNetCachePatternConverter.cs
(original)
+++ logging/log4net/trunk/src/Layout/Pattern/AspNetCachePatternConverter.cs Thu
Oct 12 08:09:59 2006
@@ -27,9 +27,32 @@
namespace log4net.Layout.Pattern
{
- internal sealed class AspNetCachePatternConverter :
PatternLayoutConverter
+ /// <summary>
+ /// Converter for items in the ASP.Net Cache.
+ /// </summary>
+ /// <remarks>
+ /// <para>
+ /// Outputs an item from the <see cref="HttpRuntime.Cache" />.
+ /// </para>
+ /// </remarks>
+ /// <author>Ron Grabowski</author>
+ internal sealed class AspNetCachePatternConverter :
AspNetPatternLayoutConverter
{
- protected override void Convert(TextWriter writer, LoggingEvent
loggingEvent)
+ /// <summary>
+ /// Write the ASP.Net Cache item to the output
+ /// </summary>
+ /// <param name="writer"><see cref="TextWriter" /> that will
receive the formatted result.</param>
+ /// <param name="loggingEvent">The <see cref="LoggingEvent" />
on which the pattern converter should be executed.</param>
+ /// <param name="httpContext">The <see cref="HttpContext" />
under which the ASP.Net request is running.</param>
+ /// <remarks>
+ /// <para>
+ /// Writes out the value of a named property. The property name
+ /// should be set in the <see
cref="log4net.Util.PatternConverter.Option"/>
+ /// property. If no property has been set, all key value pairs
from the Cache will
+ /// be written to the output.
+ /// </para>
+ /// </remarks>
+ protected override void Convert(TextWriter writer, LoggingEvent
loggingEvent, HttpContext httpContext)
{
if (HttpRuntime.Cache != null)
{
Modified:
logging/log4net/trunk/src/Layout/Pattern/AspNetContextPatternConverter.cs
URL:
http://svn.apache.org/viewvc/logging/log4net/trunk/src/Layout/Pattern/AspNetContextPatternConverter.cs?view=diff&rev=463269&r1=463268&r2=463269
==============================================================================
--- logging/log4net/trunk/src/Layout/Pattern/AspNetContextPatternConverter.cs
(original)
+++ logging/log4net/trunk/src/Layout/Pattern/AspNetContextPatternConverter.cs
Thu Oct 12 08:09:59 2006
@@ -26,8 +26,30 @@
namespace log4net.Layout.Pattern
{
- internal sealed class AspNetContextPatternConverter :
AspNetPatternConverter
+ /// <summary>
+ /// Converter for items in the <see cref="HttpContext" />.
+ /// </summary>
+ /// <remarks>
+ /// <para>
+ /// Outputs an item from the <see cref="HttpContext" />.
+ /// </para>
+ /// </remarks>
+ /// <author>Ron Grabowski</author>
+ internal sealed class AspNetContextPatternConverter :
AspNetPatternLayoutConverter
{
+ /// <summary>
+ /// Write the ASP.Net HttpContext item to the output
+ /// </summary>
+ /// <param name="writer"><see cref="TextWriter" /> that will
receive the formatted result.</param>
+ /// <param name="loggingEvent">The <see cref="LoggingEvent" />
on which the pattern converter should be executed.</param>
+ /// <param name="httpContext">The <see cref="HttpContext" />
under which the ASP.Net request is running.</param>
+ /// <remarks>
+ /// <para>
+ /// Writes out the value of a named property. The property name
+ /// should be set in the <see
cref="log4net.Util.PatternConverter.Option"/>
+ /// property.
+ /// </para>
+ /// </remarks>
protected override void Convert(TextWriter writer, LoggingEvent
loggingEvent, HttpContext httpContext)
{
WriteObject(writer, loggingEvent.Repository,
httpContext.Items[Option]);
Modified: logging/log4net/trunk/src/Layout/Pattern/AspNetPatternConverter.cs
URL:
http://svn.apache.org/viewvc/logging/log4net/trunk/src/Layout/Pattern/AspNetPatternConverter.cs?view=diff&rev=463269&r1=463268&r2=463269
==============================================================================
--- logging/log4net/trunk/src/Layout/Pattern/AspNetPatternConverter.cs
(original)
+++ logging/log4net/trunk/src/Layout/Pattern/AspNetPatternConverter.cs Thu Oct
12 08:09:59 2006
@@ -28,15 +28,15 @@
namespace log4net.Layout.Pattern
{
/// <summary>
- /// Abstract class that provides access to the HttpContext.Current that
+ /// Abstract class that provides access to the current HttpContext
(<see cref="HttpContext.Current" />) that
/// derived classes need.
/// </summary>
/// <remarks>
/// This class handles the case when HttpContext.Current is null by
writing
- /// SystemInfo.NotAvailableText to the writer.
+ /// <see cref="SystemInfo.NotAvailableText" /> to the writer.
/// </remarks>
/// <author>Ron Grabowski</author>
- internal abstract class AspNetPatternConverter : PatternLayoutConverter
+ internal abstract class AspNetPatternLayoutConverter :
PatternLayoutConverter
{
protected override void Convert(TextWriter writer, LoggingEvent
loggingEvent)
{
Modified:
logging/log4net/trunk/src/Layout/Pattern/AspNetRequestPatternConverter.cs
URL:
http://svn.apache.org/viewvc/logging/log4net/trunk/src/Layout/Pattern/AspNetRequestPatternConverter.cs?view=diff&rev=463269&r1=463268&r2=463269
==============================================================================
--- logging/log4net/trunk/src/Layout/Pattern/AspNetRequestPatternConverter.cs
(original)
+++ logging/log4net/trunk/src/Layout/Pattern/AspNetRequestPatternConverter.cs
Thu Oct 12 08:09:59 2006
@@ -27,8 +27,30 @@
namespace log4net.Layout.Pattern
{
- internal sealed class AspNetRequestPatternConverter :
AspNetPatternConverter
+ /// <summary>
+ /// Converter for items in the ASP.Net Cache.
+ /// </summary>
+ /// <remarks>
+ /// <para>
+ /// Outputs an item from the <see cref="HttpRuntime.Cache" />.
+ /// </para>
+ /// </remarks>
+ /// <author>Ron Grabowski</author>
+ internal sealed class AspNetRequestPatternConverter :
AspNetPatternLayoutConverter
{
+ /// <summary>
+ /// Write the ASP.Net Cache item to the output
+ /// </summary>
+ /// <param name="writer"><see cref="TextWriter" /> that will
receive the formatted result.</param>
+ /// <param name="loggingEvent">The <see cref="LoggingEvent" />
on which the pattern converter should be executed.</param>
+ /// <param name="httpContext">The <see cref="HttpContext" />
under which the ASP.Net request is running.</param>
+ /// <remarks>
+ /// <para>
+ /// Writes out the value of a named property. The property name
+ /// should be set in the <see
cref="log4net.Util.PatternConverter.Option"/>
+ /// property.
+ /// </para>
+ /// </remarks>
protected override void Convert(TextWriter writer, LoggingEvent
loggingEvent, HttpContext httpContext)
{
if (httpContext.Request != null)
Modified:
logging/log4net/trunk/src/Layout/Pattern/AspNetSessionPatternConverter.cs
URL:
http://svn.apache.org/viewvc/logging/log4net/trunk/src/Layout/Pattern/AspNetSessionPatternConverter.cs?view=diff&rev=463269&r1=463268&r2=463269
==============================================================================
--- logging/log4net/trunk/src/Layout/Pattern/AspNetSessionPatternConverter.cs
(original)
+++ logging/log4net/trunk/src/Layout/Pattern/AspNetSessionPatternConverter.cs
Thu Oct 12 08:09:59 2006
@@ -27,11 +27,33 @@
namespace log4net.Layout.Pattern
{
- internal sealed class AspNetSessionPatternConverter :
AspNetPatternConverter
+ /// <summary>
+ /// Converter for items in the ASP.Net Cache.
+ /// </summary>
+ /// <remarks>
+ /// <para>
+ /// Outputs an item from the <see cref="HttpRuntime.Cache" />.
+ /// </para>
+ /// </remarks>
+ /// <author>Ron Grabowski</author>
+ internal sealed class AspNetSessionPatternConverter :
AspNetPatternLayoutConverter
{
+ /// <summary>
+ /// Write the ASP.Net Cache item to the output
+ /// </summary>
+ /// <param name="writer"><see cref="TextWriter" /> that will
receive the formatted result.</param>
+ /// <param name="loggingEvent">The <see cref="LoggingEvent" />
on which the pattern converter should be executed.</param>
+ /// <param name="httpContext">The <see cref="HttpContext" />
under which the ASP.Net request is running.</param>
+ /// <remarks>
+ /// <para>
+ /// Writes out the value of a named property. The property name
+ /// should be set in the <see
cref="log4net.Util.PatternConverter.Option"/>
+ /// property. If no property has been set, all key value pairs
from the Session will
+ /// be written to the output.
+ /// </para>
+ /// </remarks>
protected override void Convert(TextWriter writer, LoggingEvent
loggingEvent, HttpContext httpContext)
{
-
if (httpContext.Session != null)
{
if (Option != null)
