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

Update IDialogResult and DialogResult #2761

Merged
merged 3 commits into from
Aug 27, 2022
Merged

Conversation

niimima
Copy link
Contributor

@niimima niimima commented Aug 25, 2022

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

  • Has tests (if omitted, state reason in description)
  • Rebased on top of master at time of PR
  • Changes adhere to coding standard

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.

@@ -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.

@@ -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.

@@ -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.
Copy link
Member

@brianlagunas brianlagunas Aug 26, 2022

Choose a reason for hiding this comment

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

looks like a copy/paste issue. Please remove the extra "returns" word.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@brianlagunas brianlagunas merged commit 839fda8 into PrismLibrary:master Aug 27, 2022
@brianlagunas
Copy link
Member

Thanks you so much for the docs!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants