Skip to content

Commit a48c073

Browse files
committed
Improved Comments for better SHFB Documentation
1 parent 4e48095 commit a48c073

File tree

4 files changed

+12
-12
lines changed

4 files changed

+12
-12
lines changed

EssentialMVVM/ObservableObjectBase.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111
namespace PT.EssentialMVVM
1212
{
1313
/// <summary>
14-
/// The <see cref="ObservableObjectBase"/> Class is a basic implementation of the INotifyPropertyChanged
15-
/// interface to be used as a base class for Models
14+
/// A basic implementation of the <see cref="INotifyPropertyChanged"/> interface to be used
15+
/// as a base class for Models.
1616
/// </summary>
1717
public abstract class ObservableObjectBase : INotifyPropertyChanged
1818
{

EssentialMVVM/ThreadHelper.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@
1313
namespace PT.EssentialMVVM
1414
{
1515
/// <summary>
16-
/// <see cref="ThreadHelper"/> static class.
16+
/// A static class to provide helper functions for working with threads.
1717
/// </summary>
1818
public static class ThreadHelper
1919
{
2020
/// <summary>
2121
/// Invoke Code on the Main Thread
2222
/// </summary>
23-
/// <param name="action">Code to Execute</param>
23+
/// <param name="action">Action to Execute on the Main Thread</param>
2424
public static void InvokeOnMainThread(Action action)
2525
{
2626
// Checks the application's instance of AppDomain is initialized

EssentialMVVM/ViewModelBase.cs

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111
namespace PT.EssentialMVVM
1212
{
1313
/// <summary>
14-
/// <see cref="ViewModelBase"/> Class is an extension of the <see cref="ObservableObjectBase"/> class
15-
/// to be used as a BaseClass for ViewModels
14+
/// An extension of the <see cref="ObservableObjectBase"/> class to be used as a
15+
/// base class for ViewModels.
1616
/// </summary>
1717
public abstract class ViewModelBase : ObservableObjectBase
1818
{
@@ -21,7 +21,7 @@ public abstract class ViewModelBase : ObservableObjectBase
2121
/// <summary>
2222
/// Invoke Code on the Main Thread
2323
/// </summary>
24-
/// <param name="action">Code to Execute</param>
24+
/// <param name="action">Action to Execute on the Main Thread</param>
2525
public void InvokeOnMainThread(Action action)
2626
{
2727
ThreadHelper.InvokeOnMainThread(action);

EssentialMVVM/ViewModelCommand.cs

+5-5
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
namespace PT.EssentialMVVM
1313
{
1414
/// <summary>
15-
/// An implementation of ICommand that can be initialized in a ViewModel for
16-
/// execution, through binding, by a Control in a View.
15+
/// An implementation of the <see cref="ICommand"/> interface that can be initialized
16+
/// in a ViewModel for execution, through binding, by a Control in a View.
1717
/// </summary>
1818
public class ViewModelCommand : ICommand
1919
{
@@ -31,7 +31,7 @@ public class ViewModelCommand : ICommand
3131
/// Initializes a new instance of the <see cref="ViewModelCommand"/> class.
3232
/// </summary>
3333
/// <remarks>The command can always be executed</remarks>
34-
/// <param name="execute">The command to Execute</param>
34+
/// <param name="execute">The action for the Command to Execute</param>
3535
public ViewModelCommand(Action execute)
3636
: this(execute, null)
3737
{
@@ -41,7 +41,7 @@ public ViewModelCommand(Action execute)
4141
/// <summary>
4242
/// Initializes a new instance of the <see cref="ViewModelCommand"/> class.
4343
/// </summary>
44-
/// <param name="command">The command to Execute</param>
44+
/// <param name="command">The action for the Command to Execute</param>
4545
/// <param name="canExecute">A function that determines whether the Command can be Executed</param>
4646
public ViewModelCommand(Action command, Func<bool> canExecute)
4747
{
@@ -83,7 +83,7 @@ public event EventHandler CanExecuteChanged
8383
}
8484

8585
/// <summary>
86-
/// Used by the command to determine whether the Command can be Executed
86+
/// Determine if the Command can be Executed
8787
/// </summary>
8888
/// <param name="parameter">object used by the command</param>
8989
/// <remarks>If null is passed, the return value will be true</remarks>

0 commit comments

Comments
 (0)