From 282e889c78adf74d645827d3cdc2d77fcbb65fc9 Mon Sep 17 00:00:00 2001
From: Benjamin Popp <haven1433@gmail.com>
Date: Sat, 17 Nov 2018 18:47:52 -0600
Subject: [PATCH] commenting the parameters for the commands

---
 Gen3Hex/ViewModel/EditorViewModel.cs | 14 +++++++-------
 Gen3Hex/ViewModel/ITabContent.cs     | 10 +++++-----
 Gen3Hex/ViewModel/IViewPort.cs       |  2 +-
 3 files changed, 13 insertions(+), 13 deletions(-)

diff --git a/Gen3Hex/ViewModel/EditorViewModel.cs b/Gen3Hex/ViewModel/EditorViewModel.cs
index 6ddd64e0..e319db55 100644
--- a/Gen3Hex/ViewModel/EditorViewModel.cs
+++ b/Gen3Hex/ViewModel/EditorViewModel.cs
@@ -20,7 +20,7 @@ namespace HavenSoft.Gen3Hex.ViewModel {
       private int currentFindResultIndex;
 
       public ICommand New => newCommand;
-      public ICommand Open => open;
+      public ICommand Open => open;                // parameter: file to open (or null)
       public ICommand Save => save;
       public ICommand SaveAs => saveAs;
       public ICommand SaveAll => saveAll;
@@ -34,12 +34,12 @@ namespace HavenSoft.Gen3Hex.ViewModel {
       public ICommand Delete => delete;
       public ICommand Back => back;
       public ICommand Forward => forward;
-      public ICommand Goto => gotoCommand;
-      public ICommand ShowGoto => showGoto;
-      public ICommand Find => find;
-      public ICommand FindPrevious => findPrevious;
-      public ICommand FindNext => findNext;
-      public ICommand ShowFind => showFind;
+      public ICommand Goto => gotoCommand;          // parameter: target destination as string (for example, a hex address)
+      public ICommand ShowGoto => showGoto;         // parameter: true for show, false for hide
+      public ICommand Find => find;                 // parameter: target string to search
+      public ICommand FindPrevious => findPrevious; // parameter: target string to search
+      public ICommand FindNext => findNext;         // parameter: target string to search
+      public ICommand ShowFind => showFind;         // parameter: true for show, false for hide
       public ICommand ClearError => clearError;
 
       private bool gotoControlVisible;
diff --git a/Gen3Hex/ViewModel/ITabContent.cs b/Gen3Hex/ViewModel/ITabContent.cs
index 1b2bc54a..91b1642c 100644
--- a/Gen3Hex/ViewModel/ITabContent.cs
+++ b/Gen3Hex/ViewModel/ITabContent.cs
@@ -7,16 +7,16 @@ namespace HavenSoft.Gen3Hex.ViewModel {
    /// </summary>
    public interface ITabContent {
       string Name { get; }
-      ICommand Save { get; }
-      ICommand SaveAs { get; }
+      ICommand Save { get; }   // parameter: IFileSystem
+      ICommand SaveAs { get; } // parameter: IFileSystem
       ICommand Undo { get; }
       ICommand Redo { get; }
-      ICommand Copy { get; }
+      ICommand Copy { get; }   // parameter: IFileSystem
       ICommand Clear { get; }
-      ICommand Goto { get; }
+      ICommand Goto { get; }   // parameter: target destination as string (example, a hex address)
       ICommand Back { get; }
       ICommand Forward { get; }
-      ICommand Close { get; }
+      ICommand Close { get; }  // parameter: IFileSystem
 
       event EventHandler<string> OnError;
       event EventHandler Closed;
diff --git a/Gen3Hex/ViewModel/IViewPort.cs b/Gen3Hex/ViewModel/IViewPort.cs
index 2b4b13f9..55b2d192 100644
--- a/Gen3Hex/ViewModel/IViewPort.cs
+++ b/Gen3Hex/ViewModel/IViewPort.cs
@@ -14,7 +14,7 @@ namespace HavenSoft.Gen3Hex.ViewModel {
       int ScrollValue { get; set;  }
       int MaximumScroll { get; }
       ObservableCollection<string> Headers { get; }
-      ICommand Scroll { get; }
+      ICommand Scroll { get; } // parameter: Direction to scroll
 
       HexElement this[int x, int y] { get; }
       bool IsSelected(Point point);