From c85f8b23e6df1b948b029810ca41e5817be0f3d1 Mon Sep 17 00:00:00 2001
From: Mark Watkins <jedimark@users.sourceforge.net>
Date: Mon, 19 Dec 2011 18:17:19 +1000
Subject: [PATCH] Doxygen main stuff

---
 SleepLib/loader_plugins/zeo_loader.cpp |  2 +-
 SleepLib/machine.h                     |  6 +++---
 mainwindow.h                           | 29 ++++++++++++++++++++++++++
 3 files changed, 33 insertions(+), 4 deletions(-)

diff --git a/SleepLib/loader_plugins/zeo_loader.cpp b/SleepLib/loader_plugins/zeo_loader.cpp
index 12b7c98d..20d95424 100644
--- a/SleepLib/loader_plugins/zeo_loader.cpp
+++ b/SleepLib/loader_plugins/zeo_loader.cpp
@@ -6,7 +6,7 @@ License: GPL
 */
 
 //********************************************************************************************
-/// IMPORTANT!!!
+// IMPORTANT!!!
 //********************************************************************************************
 // Please INCREMENT the zeo_data_version in zel_loader.h when making changes to this loader
 // that change loader behaviour or modify channels.
diff --git a/SleepLib/machine.h b/SleepLib/machine.h
index 110c3eba..319ec90e 100644
--- a/SleepLib/machine.h
+++ b/SleepLib/machine.h
@@ -150,7 +150,7 @@ protected:
 
 
 /*! \class CPAP
-    \brief A CPAP classed machine object.. These are only really for show
+    \brief A CPAP classed machine object..
     */
 class CPAP:public Machine
 {
@@ -161,7 +161,7 @@ public:
 
 
 /*! \class Oximeter
-    \brief An Oximeter classed machine object.. These are only really for show
+    \brief An Oximeter classed machine object..
     */
 class Oximeter:public Machine
 {
@@ -172,7 +172,7 @@ protected:
 };
 
 /*! \class SleepStage
-    \brief A SleepStage classed machine object.. These are only really for show
+    \brief A SleepStage classed machine object..
     */
 class SleepStage:public Machine
 {
diff --git a/mainwindow.h b/mainwindow.h
index b5fa3ec3..3a34a870 100644
--- a/mainwindow.h
+++ b/mainwindow.h
@@ -25,6 +25,35 @@ namespace Ui {
     class MainWindow;
 }
 
+/*! \mainpage SleepyHead
+
+ \section intro_sec Introduction
+
+ SleepyHead is Cross-Platform Open-Source software for reviewing data from %CPAP machines, which are used in the treatment of Sleep Disorders.
+
+ SleepyHead has been created by <a href="http://jedimark64.blogspot.com">Mark Watkins</a> (JediMark), an Australian software developer.
+
+ This document is an attempt to provide a little technical insight into SleepyHead's program internals.
+
+ \section project_info Further Information
+ The project is hosted on sourceforge, and it's project page can be reached at <a href="http://sourceforge.net/projects/sleepyhead">http://sourceforge.net/projects/sleepyhead</a>.
+
+ There is also the <a href="http://sleepyhead.sourceforge.net">SleepyHead Wiki</a> containing further information
+
+ \section structure Program Structure
+ SleepyHead is written in C++ using Qt Toolkit library, and comprises of 3 main components
+ \list
+ \li The SleepLib Database, a specialized database for working with multiple sources of Sleep machine data.
+ \li A custom designed, high performance and interactive OpenGL Graphing Library.
+ \li and the main Application user interface.
+ \endlist
+
+ This document is still a work in progress, right now all the classes and sections are jumbled together.
+
+ */
+
+// * \section install_sec Installation
+
 extern QStatusBar *qstatusbar;
 
 class Daily;