Skip to content

[Docs] Add doc snippet tags for safer references from Learn #1936

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
liliankasem merged 5 commits into from
Sep 28, 2023
Merged

[Docs] Add doc snippet tags for safer references from Learn #1936

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3a83576
Adding code snippet tags
ggailey777 Oct 19, 2022
8653a39
And making the snippets into comments 🤦‍♂️
ggailey777 Oct 19, 2022
41d4c9c
Merge branch 'main' of https://github.com/Azure/azure-functions-dotne…
ggailey777 Aug 18, 2023
886f428
Merge branch 'main' of https://github.com/Azure/azure-functions-dotne…
ggailey777 Sep 28, 2023
5f09a46
Add snippet tags to Service Bus samples
ggailey777 Sep 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions samples/Extensions/ServiceBus/ServiceBusReceivedMessageFunctions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (c) .NET Foundation. All rights reserved.
// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.

using System;
Expand All @@ -13,16 +13,18 @@ namespace SampleApp
/// </summary>
public class ServiceBusReceivedMessageFunctions
{
//<docsnippet_servicebusmessage_createlogger>
private readonly ILogger<ServiceBusReceivedMessageFunctions> _logger;

public ServiceBusReceivedMessageFunctions(ILogger<ServiceBusReceivedMessageFunctions> logger)
{
_logger = logger;
}

//</docsnippet_servicebusmessage_createlogger>
/// <summary>
/// This function demonstrates binding to a single <see cref="ServiceBusReceivedMessage"/>.
/// </summary>
//<docsnippet_servicebus_readmessage>
[Function(nameof(ServiceBusReceivedMessageFunction))]
[ServiceBusOutput("outputQueue", Connection = "ServiceBusConnection")]
public string ServiceBusReceivedMessageFunction(
Expand All @@ -35,12 +37,13 @@ public string ServiceBusReceivedMessageFunction(
var outputMessage = $"Output message created at {DateTime.Now}";
return outputMessage;
}

//</docsnippet_servicebus_readmessage>
/// <summary>
/// This function demonstrates binding to an array of <see cref="ServiceBusReceivedMessage"/>.
/// Note that when doing so, you must also set the <see cref="ServiceBusTriggerAttribute.IsBatched"/> property
/// to <value>true</value>.
/// </summary>
//<docsnippet_servicebus_readbatch>
[Function(nameof(ServiceBusReceivedMessageBatchFunction))]
public void ServiceBusReceivedMessageBatchFunction(
[ServiceBusTrigger("queue", Connection = "ServiceBusConnection", IsBatched = true)] ServiceBusReceivedMessage[] messages)
Expand All @@ -52,7 +55,7 @@ public void ServiceBusReceivedMessageBatchFunction(
_logger.LogInformation("Message Content-Type: {contentType}", message.ContentType);
}
}

//</docsnippet_servicebus_readbatch>
/// <summary>
/// This functions demonstrates that it is possible to bind to both the ServiceBusReceivedMessage and any of the supported binding contract
/// properties at the same time. If attempting this, the ServiceBusReceivedMessage must be the first parameter. There is not
Expand All @@ -72,4 +75,4 @@ public void ServiceBusReceivedMessageWithStringProperties(
_logger.LogInformation("Delivery Count: {count}", deliveryCount);
}
}
}
}