From 1c304eb13e3488324bff667c01e1216db082425d Mon Sep 17 00:00:00 2001
From: Seeker4 <guy.oscar@moxis.com>
Date: Thu, 22 Aug 2019 02:31:33 -0700
Subject: [PATCH] Add some documentation to graph modules.

---
 oscar/Graphs/gGraph.cpp     | 5 ++---
 oscar/Graphs/gGraphView.cpp | 4 +++-
 oscar/Graphs/gGraphView.h   | 1 +
 3 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/oscar/Graphs/gGraph.cpp b/oscar/Graphs/gGraph.cpp
index 05ee6776..76635008 100644
--- a/oscar/Graphs/gGraph.cpp
+++ b/oscar/Graphs/gGraph.cpp
@@ -247,11 +247,9 @@ bool gGraph::isEmpty()
     return empty;
 }
 
-
 float gGraph::printScaleX() { return m_graphview->printScaleX(); }
 float gGraph::printScaleY() { return m_graphview->printScaleY(); }
 
-
 //void gGraph::drawGLBuf()
 //{
 
@@ -264,6 +262,7 @@ float gGraph::printScaleY() { return m_graphview->printScaleY(); }
 //    }
 
 //}
+
 void gGraph::setDay(Day *day)
 {
     // Don't update for snapshots..
@@ -527,7 +526,7 @@ QPixmap gGraph::renderPixmap(int w, int h, bool printing)
     return pm;
 }
 
-// Sets a new Min & Max X clipping, refreshing the graph and all it's layers.
+// Sets a new Min & Max X dates for clipping data (refresh done by caller)
 void gGraph::SetXBounds(qint64 minx, qint64 maxx)
 {
     invalidate_xAxisImage = true;
diff --git a/oscar/Graphs/gGraphView.cpp b/oscar/Graphs/gGraphView.cpp
index 3a922afb..d7065e94 100644
--- a/oscar/Graphs/gGraphView.cpp
+++ b/oscar/Graphs/gGraphView.cpp
@@ -1122,6 +1122,7 @@ void gGraphView::GetXBounds(qint64 &st, qint64 &et)
     et = m_maxx;
 }
 
+// Supplies time range to all graph objects in linked group, refreshing if requested
 void gGraphView::SetXBounds(qint64 minx, qint64 maxx, short group, bool refresh)
 {
     for (auto & graph : m_graphs) {
@@ -1130,7 +1131,7 @@ void gGraphView::SetXBounds(qint64 minx, qint64 maxx, short group, bool refresh)
         }
     }
 
-    m_minx = minx;
+    m_minx = minx;  // left and right edges of graph, in msec in epoch
     m_maxx = maxx;
 
     if (refresh) { timedRedraw(0); }
@@ -3277,6 +3278,7 @@ void gGraphView::keyPressEvent(QKeyEvent *event)
     //qDebug() << "Keypress??";
 }
 
+// Sends day object to be distributed to all Graphs Layers objects
 void gGraphView::setDay(Day *day)
 {
 
diff --git a/oscar/Graphs/gGraphView.h b/oscar/Graphs/gGraphView.h
index 9795587e..ea6b1cd5 100644
--- a/oscar/Graphs/gGraphView.h
+++ b/oscar/Graphs/gGraphView.h
@@ -655,6 +655,7 @@ class gGraphView
 
     bool m_showsplitter;
 
+    // msec in epoch of first day and last day of range
     qint64 m_minx, m_maxx;
 
     QVector<SelectionHistoryItem> fwd_history;