From a845b625b4df9e87f6799c36b267e379386d74e5 Mon Sep 17 00:00:00 2001
From: Joel Holdsworth <joel@joel-desktop.(none)>
Date: Sat, 16 Aug 2008 17:41:57 +0100
Subject: [PATCH] Added more documentation

---
 doc/devel/.gitignore                |  2 --
 src/gui/gtk-lumiera.hpp             | 35 +++++++++++++++++++++++++++++
 src/gui/panels/panel.hpp            |  2 +-
 src/gui/panels/timeline-panel.hpp   |  7 ++++++
 src/gui/widgets/timeline-widget.hpp | 10 +++++++++
 5 files changed, 53 insertions(+), 3 deletions(-)
 delete mode 100644 doc/devel/.gitignore

diff --git a/doc/devel/.gitignore b/doc/devel/.gitignore
deleted file mode 100644
index 96886436c..000000000
--- a/doc/devel/.gitignore
+++ /dev/null
@@ -1,2 +0,0 @@
-,doxylog
-html/*
diff --git a/src/gui/gtk-lumiera.hpp b/src/gui/gtk-lumiera.hpp
index 0507ea88e..41b355d80 100644
--- a/src/gui/gtk-lumiera.hpp
+++ b/src/gui/gtk-lumiera.hpp
@@ -51,7 +51,13 @@ NOBUG_DECLARE_FLAG(gui);
 #endif
 
 namespace lumiera {
+
+/**
+ * The namespace of all GUI code.
+ */
 namespace gui {
+  
+/* ===== Global Constants ===== */
 
 /**
  *  The name of the application 
@@ -81,6 +87,8 @@ static const gchar* AppAuthors[] = {
   "Christian Thaeter",
   "Hermann Vosseler",
   "<Other Authors Here>"};
+  
+/* ===== The Application Class ===== */
 
 /**
  *  The main application class.
@@ -99,6 +107,33 @@ public:
  */
 GtkLumiera& application();
 
+/* ===== Namespace Definitions ===== */
+
+/**
+ * The namespace of all dialog box classes.
+ */
+namespace dialogs {}
+
+/**
+ * The namespace of all video output implementations.
+ */
+namespace output {}
+
+/**
+ * The namespace of all docking panel classes.
+ */
+namespace panels {}
+
+/**
+ * The namespace of all Lumiera custom widgets.
+ */
+namespace widgets {}
+
+/**
+ * The namespace of the workspace window, and it's helper classes.
+ */
+namespace workspace {}
+
 }   // namespace gui
 }   // namespace lumiera
 
diff --git a/src/gui/panels/panel.hpp b/src/gui/panels/panel.hpp
index 79b7708be..ae1c23666 100644
--- a/src/gui/panels/panel.hpp
+++ b/src/gui/panels/panel.hpp
@@ -35,7 +35,7 @@ namespace gui {
 namespace panels {
 
 /** 
-* The main lumiera workspace window
+* The main lumiera panel window
 */
 class Panel : public Gtk::VBox
 {
diff --git a/src/gui/panels/timeline-panel.hpp b/src/gui/panels/timeline-panel.hpp
index 01791f91b..37491c0d9 100644
--- a/src/gui/panels/timeline-panel.hpp
+++ b/src/gui/panels/timeline-panel.hpp
@@ -35,9 +35,16 @@ namespace lumiera {
 namespace gui {
 namespace panels {
 
+/**
+ * The definition of the timeline panel class, which holds timeline
+ * widgets.
+ */
 class TimelinePanel : public Panel
 {
 public:
+  /**
+   * Constructor
+   */
   TimelinePanel();
 
 private:
diff --git a/src/gui/widgets/timeline-widget.hpp b/src/gui/widgets/timeline-widget.hpp
index 532354793..76e4a16d7 100644
--- a/src/gui/widgets/timeline-widget.hpp
+++ b/src/gui/widgets/timeline-widget.hpp
@@ -38,7 +38,17 @@
 namespace lumiera {
 namespace gui {
 namespace widgets {
+  
+/**
+ * The namespace of all timeline widget helper classes.
+ */
+namespace timeline {}
 
+/**
+ * The timeline widget class.
+ * @remarks This widget is a composite of several widgets contained
+ * within the timeline namespace.
+ */
 class TimelineWidget : public Gtk::Table
 {
 public: