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.

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

Update IDialogResult and DialogResult #2761

Merged
merged 3 commits into from
Aug 27, 2022
+16 −0
Merged

Update IDialogResult and DialogResult #2761

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0cc89bd
Update IDialogResult and DialogResult
niimima Aug 25, 2022
6ca04fd
Update IDialogResult and DialogResult comments
niimima Aug 26, 2022
8783540
Remove a extra "returns" word.
niimima Aug 27, 2022
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
11 changes: 11 additions & 0 deletions src/Forms/Prism.Forms/Services/Dialogs/DialogResult.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can use the inherit doc tag instead of duplicating

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I use the inherit doc tag.
https://github.com/PrismLibrary/Prism/pull/2761/files#diff-0d0a9b1f968cdc60f0420e45398c06795f2b4d473269f729f6a2f977c96ac071

/// </summary>
internal class DialogResult : IDialogResult
{
/// <summary>
/// The exception of the dialog.
/// </summary>
public Exception Exception { get; set; }

/// <summary>
/// The parameters from the dialog.
/// </summary>
public IDialogParameters Parameters { get; set; }
}
}
11 changes: 11 additions & 0 deletions src/Forms/Prism.Forms/Services/Dialogs/IDialogResult.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,20 @@

namespace Prism.Services.Dialogs
{
/// <summary>
/// Contains <see cref="IDialogParameters"/> from the dialog
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

/// and the <see cref="System.Exception"/> of the dialog.
/// </summary>
public interface IDialogResult
{
/// <summary>
/// The exception of the dialog.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I use the format as bellow:
https://github.com/PrismLibrary/Prism/pull/2761/files#diff-627f40b52b5622df540ef8100476c49cc13a491a5c1e17177ce2ab9a409d0e97R11
https://github.com/PrismLibrary/Prism/pull/2761/files#diff-627f40b52b5622df540ef8100476c49cc13a491a5c1e17177ce2ab9a409d0e97R16

/// </summary>
Exception Exception { get; }

/// <summary>
/// The parameters from the dialog.
/// </summary>
IDialogParameters Parameters { get; }
}
}