Skip to content

Commit

Permalink
Improve doccomments for "connection" property.
Browse files Browse the repository at this point in the history
Removed use of "inheritdoc" since Visual Studio does not honor it when generating intellisense files.
  • Loading branch information
lindydonna authored and mathewc committed Jul 7, 2017
1 parent fa979a1 commit c320218
Show file tree
Hide file tree
Showing 12 changed files with 32 additions and 14 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ public EventHubAttribute(string eventHubName)
public string EventHubName { get; private set; }

/// <summary>
/// Optional connection name. If missing, tries to use a registered event hub sender.
/// Gets or sets the optional app setting name that contains the Event Hub connection string. If missing, tries to use a registered event hub sender.
/// </summary>
[AppSetting]
public string Connection { get; set; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public EventHubTriggerAttribute(string eventHubName)
public string ConsumerGroup { get; set; }

/// <summary>
/// Optional connection name. If missing, tries to use a registered event hub receiver.
/// Gets or sets the optional app setting name that contains the Event Hub connection string. If missing, tries to use a registered event hub receiver.
/// </summary>
[AppSetting]
public string Connection { get; set; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,13 @@ public ServiceBusAccountAttribute(string account)
}

/// <summary>
/// Gets the name of the ServiceBus connection string to use.
/// Gets or sets the name of the app setting that contains the Service Bus connection string.
/// </summary>
public string Account { get; private set; }

/// <inheritdoc />
/// <summary>
/// Gets or sets the app setting name that contains the Service Bus connection string.
/// </summary>
string IConnectionProvider.Connection
{
get
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,9 @@ public ServiceBusAttribute(string queueOrTopicName, AccessRights access)
/// </summary>
public string QueueOrTopicName { get; private set; }

/// <inheritdoc />
/// <summary>
/// Gets or sets the app setting name that contains the Service Bus connection string.
/// </summary>
public string Connection { get; set; }

/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,9 @@ public ServiceBusTriggerAttribute(string topicName, string subscriptionName, Acc
Access = access;
}

/// <inheritdoc />
/// <summary>
/// Gets or sets the app setting name that contains the Service Bus connection string.
/// </summary>
public string Connection { get; set; }

/// <summary>
Expand Down
4 changes: 3 additions & 1 deletion src/Microsoft.Azure.WebJobs/BlobAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,9 @@ public FileAccess? Access
get { return _access; }
}

/// <inheritdoc />
/// <summary>
/// Gets or sets the app setting name that contains the Azure Storage connection string.
/// </summary>
public string Connection { get; set; }
}
}
4 changes: 3 additions & 1 deletion src/Microsoft.Azure.WebJobs/BlobTriggerAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,9 @@ public BlobTriggerAttribute(string blobPath)
_blobPath = blobPath;
}

/// <inheritdoc />
/// <summary>
/// Gets or sets the app setting name that contains the Azure Storage connection string.
/// </summary>
public string Connection { get; set; }

/// <summary>Gets the path of the blob to which to bind.</summary>
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.Azure.WebJobs/IConnectionProvider.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ namespace Microsoft.Azure.WebJobs
public interface IConnectionProvider
{
/// <summary>
/// Gets the name of the connection string to use.
/// Gets or sets the app setting name that contains the connection string.
/// </summary>
string Connection { get; set; }
}
Expand Down
4 changes: 3 additions & 1 deletion src/Microsoft.Azure.WebJobs/QueueAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,9 @@ public string QueueName
get { return _queueName; }
}

/// <inheritdoc />
/// <summary>
/// Gets or sets the app setting name that contains the Azure Storage connection string.
/// </summary>
public string Connection { get; set; }
}
}
4 changes: 3 additions & 1 deletion src/Microsoft.Azure.WebJobs/QueueTriggerAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,9 @@ public string QueueName
get { return _queueName; }
}

/// <inheritdoc />
/// <summary>
/// Gets or sets the app setting name that contains the Azure Storage connection string.
/// </summary>
public string Connection { get; set; }
}
}
6 changes: 4 additions & 2 deletions src/Microsoft.Azure.WebJobs/StorageAccountAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,13 @@ public StorageAccountAttribute(string account)
}

/// <summary>
/// Gets the name of the Azure Storage connection string to use.
/// Gets or sets the app setting name that contains the Azure Storage connection string.
/// </summary>
public string Account { get; private set; }

/// <inheritdoc />
/// <summary>
/// Gets or sets the app setting name that contains the Azure Storage connection string.
/// </summary>
string IConnectionProvider.Connection
{
get
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 @@ -132,7 +132,9 @@ private string DebuggerDisplay
}
}

/// <inheritdoc />
/// <summary>
/// Gets or sets the app setting name that contains the Azure Storage connection string.
/// </summary>
public string Connection { get; set; }
}
}

0 comments on commit c320218

Please sign in to comment.