Skip to content

Commit

Permalink
Minor cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
mathewc committed Oct 26, 2015
1 parent 9c0c80b commit e9884e2
Show file tree
Hide file tree
Showing 7 changed files with 25 additions and 21 deletions.
2 changes: 1 addition & 1 deletion src/Microsoft.Azure.WebJobs.Host/JobHostConfiguration.cs
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ public SingletonConfiguration Singleton
}

/// <summary>
/// Gets the configuration for log tracing.
/// Gets the configuration for event tracing.
/// </summary>
public JobHostTraceConfiguration Tracing
{
Expand Down
13 changes: 9 additions & 4 deletions src/Microsoft.Azure.WebJobs.Host/JobHostTraceConfiguration.cs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
namespace Microsoft.Azure.WebJobs.Host
{
/// <summary>
/// Configuration class containing settings related to log tracing.
/// Configuration class containing settings related to event tracing.
/// </summary>
public class JobHostTraceConfiguration
{
Expand All @@ -24,15 +24,20 @@ public JobHostTraceConfiguration()
/// Gets or sets the <see cref="TraceLevel"/> for console output.
/// The default is <see cref="TraceLevel.Info"/>.
/// </summary>
/// <remarks>
/// For local debugging it can be useful to increase the level to <see cref="TraceLevel.Verbose"/>
/// to get more details, however you shouldn't run in production that way because too much output
/// will be produced.
/// </remarks>
public TraceLevel ConsoleLevel { get; set; }

/// <summary>
/// Gets the collection of <see cref="TraceWriter"/>s that the <see cref="JobHost"/> will
/// trace logs to.
/// trace events to.
/// <remarks>
/// When <see cref="TraceWriter"/>s are added to this collection, in addition to the default
/// Dashboard/Console logging that is done, those logs will also be routed through these
/// <see cref="TraceWriter"/>s. This would allow you to intercept the logs that are written
/// Dashboard/Console event logging that is done, those events will also be routed through these
/// <see cref="TraceWriter"/>s. This would allow you to intercept the events that are written
/// to the Dashboard/Console, so you can persist/inspect as needed.
/// </remarks>
/// </summary>
Expand Down
8 changes: 4 additions & 4 deletions src/Microsoft.Azure.WebJobs.Host/StorageClientFactory.cs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
namespace Microsoft.Azure.WebJobs.Host
{
/// <summary>
/// Factory class for the creation of all Azure Storage clients used by the framework.
/// Factory class for the creation of all Azure Storage clients used by by a <see cref="JobHost"/>.
/// </summary>
/// <remarks>
/// Subclasses can override the various methods to customize client creation.
Expand All @@ -20,7 +20,7 @@ namespace Microsoft.Azure.WebJobs.Host
public class StorageClientFactory
{
/// <summary>
/// Creates a <see cref="CloudBlobClient"/> instance for the specified <see cref="CloudStorageAccount"/>.
/// Creates a <see cref="CloudBlobClient"/> instance for the specified <see cref="StorageClientFactoryContext"/>.
/// </summary>
/// <param name="context">The <see cref="StorageClientFactoryContext"/>.</param>
/// <returns>The <see cref="CloudBlobClient"/>.</returns>
Expand All @@ -34,7 +34,7 @@ public virtual CloudBlobClient CreateCloudBlobClient(StorageClientFactoryContext
}

/// <summary>
/// Creates a <see cref="CloudTableClient"/> instance for the specified <see cref="CloudStorageAccount"/>.
/// Creates a <see cref="CloudTableClient"/> instance for the specified <see cref="StorageClientFactoryContext"/>.
/// </summary>
/// <param name="context">The <see cref="StorageClientFactoryContext"/>.</param>
/// <returns>The <see cref="CloudTableClient"/>.</returns>
Expand All @@ -48,7 +48,7 @@ public virtual CloudTableClient CreateCloudTableClient(StorageClientFactoryConte
}

/// <summary>
/// Creates a <see cref="CloudQueueClient"/> instance for the specified <see cref="CloudStorageAccount"/>.
/// Creates a <see cref="CloudQueueClient"/> instance for the specified <see cref="StorageClientFactoryContext"/>.
/// </summary>
/// <param name="context">The <see cref="StorageClientFactoryContext"/>.</param>
/// <returns>The <see cref="CloudQueueClient"/>.</returns>
Expand Down
12 changes: 6 additions & 6 deletions src/Microsoft.Azure.WebJobs.Host/TraceWriter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
namespace Microsoft.Azure.WebJobs.Host
{
/// <summary>
/// Base class for trace writers used by the <see cref="JobHost"/>.
/// See <see cref="JobHostConfiguration.Tracing"/> for details.
/// Base class for trace writers used by the <see cref="JobHost"/> for
/// event logging. See <see cref="JobHostConfiguration.Tracing"/> for details.
/// </summary>
public abstract class TraceWriter
{
Expand All @@ -23,11 +23,11 @@ protected TraceWriter(TraceLevel level)

/// <summary>
/// Gets or sets the <see cref="TraceLevel"/> filter used to filter traces.
/// Only trace entries with a <see cref="TraceLevel"/> less than or equal to
/// this level will be logged.
/// Only trace events with a <see cref="TraceLevel"/> less than or equal to
/// this level will be traced.
/// <remarks>
/// Level filtering will be done externally by the <see cref="JobHost"/>, so
/// does not need to be done by this class.
/// it shouldn't be done by this class.
/// </remarks>
/// </summary>
public TraceLevel Level { get; set; }
Expand Down Expand Up @@ -80,7 +80,7 @@ public void Error(string message, Exception ex = null, string source = null)
}

/// <summary>
/// Flush any buffered trace entries.
/// Flush any buffered trace events.
/// </summary>
public virtual void Flush()
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public ServiceBusAccountAttribute(string account)
}

/// <summary>
/// Gets the ServiceBus account name to use.
/// Gets the name of the ServiceBus connection string to use.
/// </summary>
public string Account { get; private set; }
}
Expand Down
4 changes: 2 additions & 2 deletions src/Microsoft.Azure.WebJobs/DisableAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,13 @@ public DisableAttribute(Type providerType)

/// <summary>
/// Gets the name of the application setting or environment variable that will
/// be used to determine whether the function(s) will be disabled.
/// be used to determine whether the function(s) should be disabled.
/// </summary>
public string SettingName { get; private set; }

/// <summary>
/// Gets the custom <see cref="Type"/> that will be invoked to determine
/// whether the function(s) will be disabled.
/// whether the function(s) should be disabled.
/// </summary>
public Type ProviderType { get; private set; }
}
Expand Down
5 changes: 2 additions & 3 deletions src/Microsoft.Azure.WebJobs/StorageAccountAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,14 @@ public sealed class StorageAccountAttribute : Attribute
/// <param name="account">The name of the Azure Storage connection string to use. This should be the name
/// of one of the connection strings present in the application settings (or environment variables). The
/// connection string name in settings should be prefixed with the standard "AzureWebJobs" prefix, but the
/// value you specify here should not include that prefix.
/// prefix.</param>
/// value you specify here should not include that prefix.</param>
public StorageAccountAttribute(string account)
{
Account = account;
}

/// <summary>
/// Gets the name of the Azure Storage account to use.
/// Gets the name of the Azure Storage connection string to use.
/// </summary>
public string Account { get; private set; }
}
Expand Down

0 comments on commit e9884e2

Please sign in to comment.