Skip to content

Commit

Permalink
Minor cleanup, and labeling build RC1
Browse files Browse the repository at this point in the history
  • Loading branch information
mathewc committed Oct 30, 2015
1 parent e52196e commit 0581fb1
Show file tree
Hide file tree
Showing 19 changed files with 47 additions and 39 deletions.
2 changes: 1 addition & 1 deletion src/Microsoft.Azure.WebJobs.Host/ConnectionStringNames.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ public static class ConnectionStringNames
/// <summary>Gets the Azure Storage connection string name.</summary>
public static readonly string Storage = "Storage";

/// <summary>Gets the Azure Service Bus connection string name.</summary>
/// <summary>Gets the Azure ServiceBus connection string name.</summary>
public static readonly string ServiceBus = "ServiceBus";
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ public int MaxDequeueCount

/// <summary>
/// Gets or sets the <see cref="IQueueProcessorFactory"/> that will be used to create
/// <see cref="QueueProcessor"/> instances.
/// <see cref="QueueProcessor"/> instances that will be used to process messages.
/// </summary>
[CLSCompliant(false)]
public IQueueProcessorFactory QueueProcessorFactory
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ namespace Microsoft.Azure.WebJobs.Host
{
/// <summary>
/// Configuration class containing settings related to event tracing.
/// <see cref="JobHostConfiguration.Tracing"/>.
/// </summary>
public class JobHostTraceConfiguration
{
Expand Down
7 changes: 4 additions & 3 deletions src/Microsoft.Azure.WebJobs.Host/Queues/QueueProcessor.cs
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ namespace Microsoft.Azure.WebJobs.Host.Queues
/// </summary>
/// <remarks>
/// Custom <see cref="QueueProcessor"/> implementations can be registered by implementing
/// a custom <see cref="IQueueProcessorFactory"/> and setting it on the <see cref="JobHostQueuesConfiguration"/>.
/// a custom <see cref="IQueueProcessorFactory"/> and setting it via <see cref="JobHostQueuesConfiguration.QueueProcessorFactory"/>.
/// </remarks>
[CLSCompliant(false)]
public class QueueProcessor
Expand All @@ -29,7 +29,7 @@ public class QueueProcessor
private readonly int _maxDequeueCount;

/// <summary>
/// Constructs a new instance
/// Constructs a new instance.
/// </summary>
/// <param name="context">The factory context.</param>
public QueueProcessor(QueueProcessorFactoryContext context)
Expand All @@ -43,6 +43,7 @@ public QueueProcessor(QueueProcessorFactoryContext context)
_poisonQueue = context.PoisonQueue;
_trace = context.Trace;
_maxDequeueCount = context.MaxDequeueCount;

BatchSize = context.BatchSize;
NewBatchThreshold = context.NewBatchThreshold;
}
Expand All @@ -58,7 +59,7 @@ public QueueProcessor(QueueProcessorFactoryContext context)
public int BatchSize { get; protected set; }

/// <summary>
/// Gets the threshold at which a new batch of messages will be fetched.
/// Gets or sets the threshold at which a new batch of messages will be fetched.
/// </summary>
public int NewBatchThreshold { get; protected set; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@
namespace Microsoft.Azure.WebJobs.Host.Queues
{
/// <summary>
/// Provides context input for <see cref="IQueueProcessorFactory"/>
/// Provides context input for <see cref="IQueueProcessorFactory"/>.
/// </summary>
[CLSCompliant(false)]
public class QueueProcessorFactoryContext
{
/// <summary>
/// Constructs a new instance
/// Constructs a new instance.
/// </summary>
/// <param name="queue">The <see cref="CloudQueue"/> the <see cref="QueueProcessor"/> will operate on.</param>
/// <param name="trace">The <see cref="TraceWriter"/> to write to.</param>
/// <param name="trace">The <see cref="TraceWriter"/> to trace events to.</param>
/// <param name="poisonQueue">The queue to move messages to when unable to process a message after the maximum dequeue count has been exceeded. May be null.</param>
public QueueProcessorFactoryContext(CloudQueue queue, TraceWriter trace, CloudQueue poisonQueue = null)
{
Expand All @@ -35,7 +35,7 @@ public QueueProcessorFactoryContext(CloudQueue queue, TraceWriter trace, CloudQu
}

/// <summary>
/// Constructs a new instance
/// Constructs a new instance.
/// </summary>
/// <param name="queue">The <see cref="CloudQueue"/> the <see cref="QueueProcessor"/> will operate on.</param>
/// <param name="trace">The <see cref="TraceWriter"/> to write to.</param>
Expand All @@ -50,20 +50,18 @@ internal QueueProcessorFactoryContext(CloudQueue queue, TraceWriter trace, IQueu
}

/// <summary>
/// Gets or sets the <see cref="CloudQueue"/> the
/// <see cref="QueueProcessor"/> will operate on.
/// Gets the <see cref="CloudQueue"/> the <see cref="QueueProcessor"/> will operate on.
/// </summary>
public CloudQueue Queue { get; private set; }

/// <summary>
/// Gets or sets the <see cref="CloudQueue"/> for
/// poison messages that the <see cref="QueueProcessor"/> will use.
/// Gets the <see cref="CloudQueue"/> for poison messages that the <see cref="QueueProcessor"/> will use.
/// May be null.
/// </summary>
public CloudQueue PoisonQueue { get; private set; }

/// <summary>
/// Gets or sets the <see cref="TraceWriter"/>.
/// Gets the <see cref="TraceWriter"/>.
/// </summary>
public TraceWriter Trace { get; private set; }

Expand Down
2 changes: 1 addition & 1 deletion 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 by a <see cref="JobHost"/>.
/// Factory class for all Azure Storage clients used by by a <see cref="JobHost"/>.
/// </summary>
/// <remarks>
/// Subclasses can override the various methods to customize client creation.
Expand Down
6 changes: 3 additions & 3 deletions src/Microsoft.Azure.WebJobs.Host/TraceWriter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,21 @@ namespace Microsoft.Azure.WebJobs.Host
{
/// <summary>
/// Base class for trace writers used by the <see cref="JobHost"/> for
/// event logging. See <see cref="JobHostConfiguration.Tracing"/> for details.
/// event tracing. See <see cref="JobHostConfiguration.Tracing"/> for details.
/// </summary>
public abstract class TraceWriter
{
/// <summary>
/// Constructs a new instance.
/// </summary>
/// <param name="level">The <see cref="TraceLevel"/> used to filter traces.</param>
/// <param name="level">The <see cref="TraceLevel"/> used to filter trace events.</param>
protected TraceWriter(TraceLevel level)
{
Level = level;
}

/// <summary>
/// Gets or sets the <see cref="TraceLevel"/> filter used to filter traces.
/// Gets or sets the <see cref="TraceLevel"/> filter used to filter trace events.
/// Only trace events with a <see cref="TraceLevel"/> less than or equal to
/// this level will be traced.
/// <remarks>
Expand Down
6 changes: 3 additions & 3 deletions src/Microsoft.Azure.WebJobs.ServiceBus/MessageProcessor.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ namespace Microsoft.Azure.WebJobs.ServiceBus
/// </summary>
/// <remarks>
/// Custom <see cref="MessageProcessor"/> implementations can be specified by implementing
/// a custom <see cref="MessagingProvider"/> and setting it on the <see cref="ServiceBusConfiguration"/>.
/// a custom <see cref="MessagingProvider"/> and setting it via <see cref="ServiceBusConfiguration.MessagingProvider"/>.
/// </remarks>
public class MessageProcessor
{
Expand Down Expand Up @@ -43,7 +43,7 @@ public MessageProcessor(OnMessageOptions messageOptions)
/// </summary>
/// <param name="message">The message to process.</param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> to use.</param>
/// <returns>True if the message processing should continue, false otherwise.</returns>
/// <returns>A <see cref="Task"/> that returns true if the message processing should continue, false otherwise.</returns>
public virtual async Task<bool> BeginProcessingMessageAsync(BrokeredMessage message, CancellationToken cancellationToken)
{
return await Task.FromResult<bool>(true);
Expand All @@ -55,7 +55,7 @@ public virtual async Task<bool> BeginProcessingMessageAsync(BrokeredMessage mess
/// <param name="message">The message to complete processing for.</param>
/// <param name="result">The <see cref="FunctionResult"/> from the job invocation.</param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> to use</param>
/// <returns></returns>
/// <returns>A <see cref="Task"/> that will complete the message processing.</returns>
public virtual async Task CompleteProcessingMessageAsync(BrokeredMessage message, FunctionResult result, CancellationToken cancellationToken)
{
if (result.Succeeded)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@

namespace Microsoft.Azure.WebJobs
{
/// <summary>Binds to Azure Service Bus Queues and Topics.</summary>
/// <summary>
/// Attribute used to bind a parameter to Azure ServiceBus Queues and Topics.
/// </summary>
/// <remarks>
/// The method parameter type can be one of the following:
/// <list type="bullet">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
namespace Microsoft.Azure.WebJobs
{
/// <summary>
/// Represents an attribute that binds a parameter to a Service Bus Queue message, causing the method to run when a
/// Attribute used to bind a parameter to a ServiceBus Queue message, causing the function to run when a
/// message is enqueued.
/// </summary>
/// <remarks>
Expand Down
6 changes: 2 additions & 4 deletions src/Microsoft.Azure.WebJobs/BlobAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,13 @@
using System.Collections.Generic;
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Globalization;
using System.IO;

namespace Microsoft.Azure.WebJobs
{
/// <summary>
/// Represents an attribute for binding parameters to Azure Blobs.
/// The attribute supports binding to single blobs, blob containers,
/// or collections of blobs.
/// Attribute used to bind a parameter to an Azure Blob. The attribute supports binding
/// to single blobs, blob containers, or collections of blobs.
/// </summary>
/// <remarks>
/// The method parameter type can be one of the following:
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.Azure.WebJobs/BlobTriggerAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
namespace Microsoft.Azure.WebJobs
{
/// <summary>
/// Represents an attribute that binds a parameter to an Azure Blob, causing the method to run when a blob is
/// Attribute used to bind a parameter to an Azure Blob, causing the method to run when a blob is
/// uploaded.
/// </summary>
/// <remarks>
Expand Down
9 changes: 7 additions & 2 deletions src/Microsoft.Azure.WebJobs/IBinder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,16 @@

namespace Microsoft.Azure.WebJobs
{
/// <summary>Represents an attribute binder.</summary>
/// <summary>
/// Interface defining functionality for dynamically binding to WebJobs SDK attributes
/// at runtime.
/// </summary>
/// <remarks>This interface enables imperative binding with attribute information specified at runtime.</remarks>
public interface IBinder
{
/// <summary>Binds the specified attribute.</summary>
/// <summary>
/// Binds the specified attribute.
/// </summary>
/// <typeparam name="T">The type to which to bind.</typeparam>
/// <param name="attribute">The attribute to bind.</param>
/// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.Azure.WebJobs/NoAutomaticTriggerAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
namespace Microsoft.Azure.WebJobs
{
/// <summary>
/// Represents an attribute that indicates a function for which no automatic trigger listening is performed.
/// Attribute used to mark a job function that will not be automatically triggered.
/// </summary>
/// <remarks>
/// This attribute is useful in two cases:
Expand Down
9 changes: 5 additions & 4 deletions src/Microsoft.Azure.WebJobs/QueueAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@

namespace Microsoft.Azure.WebJobs
{
/// <summary>Represents an attribute that binds a parameter to an Azure Queue.</summary>
/// <summary>
/// Attribute used to bind a parameter to an Azure Queue.
/// </summary>
/// <remarks>
/// The method parameter type can be one of the following:
/// <list type="bullet">
Expand All @@ -17,9 +19,8 @@ namespace Microsoft.Azure.WebJobs
/// <item><description><see cref="string"/> (out parameter)</description></item>
/// <item><description><see cref="T:byte[]"/> (out parameter)</description></item>
/// <item><description>A user-defined type (out parameter, serialized as JSON)</description></item>
/// <item><description>
/// <see cref="ICollection{T}"/> of these types (to enqueue multiple messages via <see cref="ICollection{T}.Add"/>
/// </description></item>
/// <item><description><see cref="ICollector{T}"/> of these types (to enqueue multiple messages via <see cref="ICollector{T}.Add"/></description></item>
/// <item><description><see cref="IAsyncCollector{T}"/> of these types (to enqueue multiple messages via <see cref="IAsyncCollector{T}.AddAsync(T, System.Threading.CancellationToken)"/></description></item>
/// </list>
/// </remarks>
[AttributeUsage(AttributeTargets.Parameter)]
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.Azure.WebJobs/QueueTriggerAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
namespace Microsoft.Azure.WebJobs
{
/// <summary>
/// Represents an attribute that binds a parameter to an Azure Queue message, causing the method to run when a
/// Attribute used to bind a parameter to an Azure Queue message, causing the function to run when a
/// message is enqueued.
/// </summary>
/// <remarks>
Expand Down
4 changes: 3 additions & 1 deletion src/Microsoft.Azure.WebJobs/TableAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@

namespace Microsoft.Azure.WebJobs
{
/// <summary>Represents an attribute that binds a parameter to an Azure Table or Table entity.</summary>
/// <summary>
/// Attribute used to bind a parameter to an Azure Table or Table entity.
/// </summary>
/// <remarks>
/// When only the table name is provided, the attribute binds to a table, and the method parameter type can be one
/// of the following:
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.Azure.WebJobs/TimeoutAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public sealed class TimeoutAttribute : Attribute
/// <summary>
/// Constructs a new instance.
/// </summary>
/// <param name="timeout">The timeout limit as a <see cref="TimeSpan"/> string.</param>
/// <param name="timeout">The timeout limit as a <see cref="TimeSpan"/> string (e.g. "00:30:00").</param>
public TimeoutAttribute(string timeout)
{
Timeout = TimeSpan.Parse(timeout, CultureInfo.InvariantCulture);
Expand Down
2 changes: 1 addition & 1 deletion tools/NuGetProj.settings.targets
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<WebJobsToolsPath>$(MSBuildThisFileDirectory)</WebJobsToolsPath>
<WebJobsPackageEULA>http://www.microsoft.com/web/webpi/eula/aspnetcomponent_rtw_enu.htm</WebJobsPackageEULA>
<Version>1.1.0</Version>
<PrereleaseTag>-beta1</PrereleaseTag>
<PrereleaseTag>-rc1</PrereleaseTag>
</PropertyGroup>
<Choose>
<When Condition=" '$(IncludeBuildNumberInVersion)' == '1'">
Expand Down

0 comments on commit 0581fb1

Please sign in to comment.