Skip to content

Commit

Permalink
Merge pull request #973 from Microsoft/jofing/docXML0920
Browse files Browse the repository at this point in the history
Fix broken doc XML and some minor spelling and grammar issues.
  • Loading branch information
cleemullins authored Sep 20, 2018
2 parents e7b6b62 + 510f847 commit de4c559
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 15 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ public class FindChoicesOptions : FindValuesOptions

/// <summary>
/// Gets or sets a value indicating whether the title of the choices action will NOT be searched over.
/// The default is <c><false</c>. This is optional.
/// The default is <c>false</c>. This is optional.
/// </summary>
/// <value>
/// A <c>true</c> if the title of the choices action will NOT be searched over; otherwise <c><false</c>.
/// A <c>true</c> if the title of the choices action will NOT be searched over; otherwise <c>false</c>.
/// </value>
public bool NoAction { get; set; }
}
Expand Down
12 changes: 6 additions & 6 deletions libraries/Microsoft.Bot.Builder.Dialogs/ComponentDialog.cs
Original file line number Diff line number Diff line change
Expand Up @@ -110,10 +110,10 @@ public ComponentDialog(string dialogId)
}

/// <summary>
/// Add a dialog to the component dialog.
/// Adds a dialog to the component dialog.
/// </summary>
/// <param name="dialog">dialog</param>
/// <returns>componentDialog for fluent calls</returns>
/// <param name="dialog">The dialog to add.</param>
/// <returns>The updated <see cref="ComponentDialog"/>.</returns>
public ComponentDialog AddDialog(Dialog dialog)
{
_dialogs.Add(dialog);
Expand All @@ -126,10 +126,10 @@ public ComponentDialog AddDialog(Dialog dialog)
}

/// <summary>
/// find a dialog by id.
/// Finds a dialog by ID.
/// </summary>
/// <param name="dialogId">dialogId</param>
/// <returns>Dialog</returns>
/// <param name="dialogId">The ID of the dialog to find.</param>
/// <returns>The dialog; or <c>null</c> if there is not a match for the ID.</returns>
public Dialog FindDialog(string dialogId)
{
return _dialogs.Find(dialogId);
Expand Down
2 changes: 0 additions & 2 deletions libraries/Microsoft.Bot.Builder.Dialogs/DialogContext.cs
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ public class DialogContext
/// <param name="dialogs">Parent dialog set.</param>
/// <param name="turnContext">Context for the current turn of conversation with the user.</param>
/// <param name="state">Current dialog state.</param>
/// <param name="onCompleted">An action to perform when the dialog completes, that is,
/// when <see cref="EndAsync(IDictionary{string, object})"/> is called on the current context.</param>
internal DialogContext(DialogSet dialogs, ITurnContext turnContext, DialogState state)
{
Dialogs = dialogs ?? throw new ArgumentNullException(nameof(dialogs));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,11 @@ public class ConfirmPrompt : Prompt<bool>
/// Initializes a new instance of the <see cref="ConfirmPrompt"/> class.
/// </summary>
/// <param name="dialogId">Dialog identifier.</param>
/// <param name="culture">Culture to use if <c>DialogContext.Context.Activity.Locale</c> property not specified. Defaults to a value of. <code>CultureInfo.CurrentCulture</code>.</param>
/// <param name="validator">Validator that will be called each time the user responds to the prompt. If the validator replies with a message no additional retry prompt will be sent.</param>
/// <param name="defaultLocale">The Locale used by default.</param>
/// <param name="validator">Validator that will be called each time the user responds to the prompt.
/// If the validator replies with a message no additional retry prompt will be sent.</param>
/// <param name="defaultLocale">The default culture or locale to use if the <see cref="Activity.Locale"/>
/// of the <see cref="DialogContext"/>.<see cref="DialogContext.Context"/>.<see cref="ITurnContext.Activity"/>
/// is not specified.</param>
public ConfirmPrompt(string dialogId, PromptValidator<bool> validator = null, string defaultLocale = null)
: base(dialogId, validator)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ internal WaterfallStepContext(WaterfallDialog parent, DialogContext dc, object o
/// </summary>
/// <param name="result">Optional result to pass to next step.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>A <see cref="Task"/> of <see cref="cref="DialogTurnResult"/> representing the asynchronous operation.</returns>
/// <returns>A <see cref="Task"/> of <see cref="DialogTurnResult"/> representing the asynchronous operation.</returns>
public async Task<DialogTurnResult> NextAsync(object result = null, CancellationToken cancellationToken = default(CancellationToken))
{
// Ensure next hasn't been called
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ namespace Microsoft.Bot.Builder.BotFramework
/// Channel provider which uses <see cref="ConfigurationManager.AppSettings"/> to lookup the channel service property.
/// </summary>
/// <remarks>
/// This will populate the <see cref="SimpleChannelProvider.Issuer"/> from a configuration entry with the key of <see cref="ChannelIssuerKey"/>.
/// This will populate the <see cref="SimpleChannelProvider.ChannelService"/> from a configuration entry with the key of <see cref="ChannelServiceKey"/>.
///
/// NOTE: if the keys are not present, a <c>null</c> value will be used.
/// </remarks>
Expand Down

0 comments on commit de4c559

Please sign in to comment.