Update IDialogResult and DialogResult #2761
Conversation
| public interface IDialogResult | ||
| { | ||
| /// <summary> | ||
| /// The exception of the dialog. |
There was a problem hiding this comment.
For Get/Set properties lets use the format of Gets (or sets) the [insert description here]. If no setter then do not add the "or sets" portion.
There was a problem hiding this comment.
| @@ -5,9 +5,20 @@ | |||
|
|
|||
| namespace Prism.Services.Dialogs | |||
| { | |||
| /// <summary> | |||
| /// An <see cref="IDialogResult"/> that contains <see cref="IDialogParameters"/> from the dialog | |||
| /// and the <see cref="System.Exception"/> of the dialog. | |||
There was a problem hiding this comment.
you can use the inherit doc tag instead of duplicating
There was a problem hiding this comment.
| @@ -2,9 +2,20 @@ | |||
|
|
|||
| namespace Prism.Services.Dialogs | |||
| { | |||
| /// <summary> | |||
| /// Contains <see cref="IDialogParameters"/> from the dialog | |||
There was a problem hiding this comment.
no need to duplicate the properties of the interface. Just briefly explain what the interface is used for.
Something like:
Represents a class that returns information about a dialog that has been closed.
There was a problem hiding this comment.
I refer to your advice.
https://github.com/PrismLibrary/Prism/pull/2761/files#diff-627f40b52b5622df540ef8100476c49cc13a491a5c1e17177ce2ab9a409d0e97R6
But, in the implementation class, I change the wording slightly.
https://github.com/PrismLibrary/Prism/pull/2761/files#diff-0d0a9b1f968cdc60f0420e45398c06795f2b4d473269f729f6a2f977c96ac071R9
| @@ -6,19 +6,14 @@ | |||
| namespace Prism.Services.Dialogs | |||
| { | |||
| /// <summary> | |||
| /// An <see cref="IDialogResult"/> that contains <see cref="IDialogParameters"/> from the dialog | |||
| /// and the <see cref="System.Exception"/> of the dialog. | |||
| /// Provides returns information about a dialog that has been closed. | |||
There was a problem hiding this comment.
looks like a copy/paste issue. Please remove the extra "returns" word.
There was a problem hiding this comment.
|
Thanks you so much for the docs! |
Description of Change
Add Missing XML Docs To IDialogResult and DialogResult.
I refer to PrismLibrary_Wpf comment.
I only add missing XML Docs so I omitted tests.
Bugs Fixed
API Changes
None.
Behavioral Changes
None.
PR Checklist