refs #5167. Fix GCC warning.

mantidproject · Aug 28, 2012 · 9080000 · 9080000
1 parent a708692
commit 9080000
Showing 1 changed file with 14 additions and 1 deletion.
diff --git a/Code/Mantid/MantidQt/SliceViewer/inc/MantidQtSliceViewer/PeaksPresenter.h b/Code/Mantid/MantidQt/SliceViewer/inc/MantidQtSliceViewer/PeaksPresenter.h
@@ -23,23 +23,36 @@ namespace SliceViewer
   class PeakOverlayViewFactory;
   class PeakOverlayView;
 
+  /*---------------------------------------------------------
+  Abstract PeaksPresenter
+  ----------------------------------------------------------*/
   class DLLExport PeaksPresenter
   {
   public:
     virtual void update() = 0;
     virtual void updateWithSlicePoint(const double& slicePoint) = 0;
   };
 
+  /*---------------------------------------------------------
+  NullPeaksPresenter
+
+  This implementation prevents the client code having to run Null checks on the PeaksPresenter pointer before using it.
+  ----------------------------------------------------------*/
   class DLLExport NullPeaksPresenter : public PeaksPresenter
   {
   public:
     virtual void update(){};
     virtual void updateWithSlicePoint(const double& slicePoint)
     {
       UNUSED_ARG(slicePoint);
-    };
+    }
   };
 
+  /*---------------------------------------------------------
+  ConcretePeaksPresenter
+
+  Concrete implmentation of the Peaks presenter. 
+  ----------------------------------------------------------*/
   class DLLExport ConcretePeaksPresenter : public PeaksPresenter
   {
   public: