Skip to content
Snippets Groups Projects
Commit a59cd58c authored by Oliver Bock's avatar Oliver Bock
Browse files

Minor code documentation updates

parent fe79411b
No related branches found
No related tags found
No related merge requests found
...@@ -38,11 +38,13 @@ using namespace std; ...@@ -38,11 +38,13 @@ using namespace std;
* This "compiler" takes a resource specification file, opens and loads the physical * 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 * 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 * 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 * \n
* %Resource specification file format: * %Resource specification file format:
* - Simple text file (*.orc)
* - Each line describes one resource * - 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 * - Lines starting with # are treated as comments
* - Empty lines are ignored * - Empty lines are ignored
* *
......
...@@ -217,7 +217,7 @@ void Starsphere::make_constellations() ...@@ -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 * IFO corner positions are from Myers' personal GPS and are +/- 100m
*/ */
......
...@@ -75,8 +75,7 @@ using namespace std; ...@@ -75,8 +75,7 @@ using namespace std;
* of this engine. * of this engine.
* *
* \todo The code of this implementaion is based on the former version of %Starsphere * \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 * and there's still some refactoring, code cleanup and documenting left to be done.
* some refactoring and code cleanup left to be done.
* *
* \author Oliver Bock\n * \author Oliver Bock\n
* Max-Planck-Institute for Gravitational Physics\n * Max-Planck-Institute for Gravitational Physics\n
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment