From a59cd58c692c35e2e447b14887c665e947567171 Mon Sep 17 00:00:00 2001
From: Oliver Bock <oliver.bock@aei.mpg.de>
Date: Thu, 3 Jul 2008 14:44:04 +0200
Subject: [PATCH] Minor code documentation updates

---
 src/orc/ResourceCompiler.h    | 6 ++++--
 src/starsphere/Starsphere.cpp | 2 +-
 src/starsphere/Starsphere.h   | 3 +--
 3 files changed, 6 insertions(+), 5 deletions(-)

diff --git a/src/orc/ResourceCompiler.h b/src/orc/ResourceCompiler.h
index 5daf8aa..a1cecd1 100644
--- a/src/orc/ResourceCompiler.h
+++ b/src/orc/ResourceCompiler.h
@@ -38,11 +38,13 @@ using namespace std;
  * This "compiler" takes a resource specification file, opens and loads the physical
  * files and converts their contents into normal C/C++ source code. The source code
  * comprises three arrays which can be subsequently compiled into object code which is
- * then referenced by ResourceFactory using external linkage.
+ * then referenced by ResourceFactory using external linkage.\n
  * \n
  * %Resource specification file format:
+ * - Simple text file (*.orc)
  * - Each line describes one resource
- * - The descriptor has to look like this: LogicalResourceName|PhysicalResourceName
+ * - The descriptor has to look like this: <code>LogicalResourceName|PhysicalResourceName</code>
+ * - <code>PhysicalResourceName</code> is the actual file name of the resource
  * - Lines starting with # are treated as comments
  * - Empty lines are ignored
  * 
diff --git a/src/starsphere/Starsphere.cpp b/src/starsphere/Starsphere.cpp
index b6525ad..c5c3348 100644
--- a/src/starsphere/Starsphere.cpp
+++ b/src/starsphere/Starsphere.cpp
@@ -217,7 +217,7 @@ void Starsphere::make_constellations()
 }
 
 /**
- * Create markers on sky sphere for LLO, LHO, and GEO
+ * Create markers on sky sphere for LLO, LHO, GEO and VIRGO
  * IFO corner positions are from Myers' personal GPS and are +/- 100m
  */
 
diff --git a/src/starsphere/Starsphere.h b/src/starsphere/Starsphere.h
index 8c884a2..fe536f5 100644
--- a/src/starsphere/Starsphere.h
+++ b/src/starsphere/Starsphere.h
@@ -75,8 +75,7 @@ using namespace std;
  * of this engine.
  * 
  * \todo The code of this implementaion is based on the former version of %Starsphere
- * by Bruce Allen, David Hammer and Eric Myers. Due to this there's still
- * some refactoring and code cleanup left to be done.
+ * and there's still some refactoring, code cleanup and documenting left to be done.
  * 
  * \author Oliver Bock\n
  * Max-Planck-Institute for Gravitational Physics\n
-- 
GitLab