Skip to content
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.

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

Convert raw docXML to typedoc/jsdoc comment (Dialog.onDialogEvent method) #2413

Closed
JonathanFingold opened this issue Jun 24, 2020 · 0 comments · Fixed by #2462
Closed

Convert raw docXML to typedoc/jsdoc comment (Dialog.onDialogEvent method) #2413

JonathanFingold opened this issue Jun 24, 2020 · 0 comments · Fixed by #2462
Labels
bug Indicates an unexpected problem or an unintended behavior.

Comments

@JonathanFingold
Copy link
Contributor

JonathanFingold commented Jun 24, 2020

Versions

What package version of the SDK are you using. master
What nodejs version are you using n/a
What browser version are you using n/a
What os are you using Windows

Describe the bug

C# doxXML comments have not been converted to typedoc/jsdoc comments.

To Reproduce

Steps to reproduce the behavior:

  1. Look at the code for Dialog.onDialogEvent:
    /// <summary>
    /// Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started.
    /// </summary>
    /// <param name="dc">The dialog context for the current turn of conversation.</param>
    /// <param name="e">The event being raised.</param>
    /// <param name="cancellationToken">The cancellation token.</param>
    /// <returns>True if the event is handled by the current dialog and bubbling should stop.</returns>
  2. See error.

Expected behavior

Use jsdoc/typedoc comments to document the code.

[bug]

@github-actions github-actions bot added the bug Indicates an unexpected problem or an unintended behavior. label Jun 24, 2020
@JonathanFingold JonathanFingold changed the title Convert raw docXML to typedoc/jsdoc comment (Dialog.endDialog method) Convert raw docXML to typedoc/jsdoc comment (Dialog.onDialogEvent method) Jun 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Indicates an unexpected problem or an unintended behavior.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant