[Kstars-devel] [kstars] /: Updating documentation and adding missing copyright information to projector classes. I am assuming they were written by Henry de Valence but if I am mistaken, please correct me.

Jasem Mutlaq mutlaqja at ikarustech.com
Wed Feb 11 10:49:11 UTC 2015 

Git commit 792be2dc9e5273869b7d3143e29fda4add4ff16f by Jasem Mutlaq.
Committed on 11/02/2015 at 10:47.
Pushed by mutlaqja into branch 'master'.

Updating documentation and adding missing copyright information to projector classes. I am assuming they were written by Henry de Valence but if I am mistaken, please correct me.

CCMAIL:kstars-devel at kde.org
CCMAIL:hdevalence at gmail.com

M  +7    -7    Mainpage.dox
M  +1    -2    kstars/projections/azimuthalequidistantprojector.cpp
M  +7    -2    kstars/projections/azimuthalequidistantprojector.h
M  +1    -2    kstars/projections/equirectangularprojector.cpp
M  +7    -3    kstars/projections/equirectangularprojector.h
M  +1    -2    kstars/projections/gnomonicprojector.cpp
M  +7    -3    kstars/projections/gnomonicprojector.h
M  +1    -2    kstars/projections/lambertprojector.cpp
M  +7    -3    kstars/projections/lambertprojector.h
M  +1    -2    kstars/projections/orthographicprojector.cpp
M  +7    -3    kstars/projections/orthographicprojector.h
M  +10   -6    kstars/projections/projector.h
M  +1    -2    kstars/projections/stereographicprojector.cpp
M  +7    -3    kstars/projections/stereographicprojector.h

http://commits.kde.org/kstars/792be2dc9e5273869b7d3143e29fda4add4ff16f

diff --git a/Mainpage.dox b/Mainpage.dox
index 38b3b98..f0d19de 100644
--- a/Mainpage.dox
+++ b/Mainpage.dox
@@ -19,8 +19,8 @@ they change with time, and the "view" is the graphical display of this model on
 The "model" is encapsulated in the KStarsData class, and the "view" is encapsulated in the KStars class.  Here is a list of the major components of KStars:
 
 \subsection Data Data
-    - KStarsData  (master class for the backend "model")
-    - SkyMapComposite (top of hierarchy for plottable objects)
+    - KStarsData: Master class for the backend "model".
+    - SkyMapComposite: Top of hierarchy for plottable objects.
     - SkyComponent are lists of objects of the same type that are drawn in the sky map. Individual objects are represented as an instance of SkyPoint, or one of its children.
     Only imaginary positions in the sky use SkyPoint directly.  Most real objects use the derived class SkyObject, which adds names and other data. \subpage Stars, planets, comets, asteroids, deep-sky objects, constellations,
     guide lines, the Milky Way, etc. each have their own Component
@@ -41,14 +41,14 @@ The "model" is encapsulated in the KStarsData class, and the "view" is encapsula
         - TrailObject
 
 \subsection View View
-    - KStars  (main window; master class for the frontend "view")
-    - SkyMap  (sky widget)
-    - KSPopupMenu (right-click menu)
-    - InfoBoxes (on-screen information on time, position, and focused object)
+    - KStars: main window; master class for the frontend "view".
+    - SkyMap: sky widget
+    - KSPopupMenu: right-click menu
+    - InfoBoxes: on-screen information on time, position, and focused object
     - SkyLabeler
     - Flags: FlagComponent represents a flag on the sky map and is managed by FlagManager.
     - FOVs: FOV represents a Field-of-View symbol on the skymap. The \ref FOVDialog "FOV Dialog" enables editing and \ref NewFOV "adding a new FOV".
-    - Projections
+    - \ref Projector "Projections": Multiple projection systems are supported to map the celestial sphere unto a 2D surface.
 
 \subsection Time Time
     - \subpage TimeKeeping "Time Keeping": How is time stored and simulated in KStars?
diff --git a/kstars/projections/azimuthalequidistantprojector.cpp b/kstars/projections/azimuthalequidistantprojector.cpp
index 32a4755..8b5e2ae 100644
--- a/kstars/projections/azimuthalequidistantprojector.cpp
+++ b/kstars/projections/azimuthalequidistantprojector.cpp
@@ -1,6 +1,5 @@
 /*
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
+    Copyright (C) 2010 Henry de Valence <hdevalence at gmail.com>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
diff --git a/kstars/projections/azimuthalequidistantprojector.h b/kstars/projections/azimuthalequidistantprojector.h
index 1fdde8f..0b44f17 100644
--- a/kstars/projections/azimuthalequidistantprojector.h
+++ b/kstars/projections/azimuthalequidistantprojector.h
@@ -1,6 +1,5 @@
 /*
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
+    Copyright (C) 2010 Henry de Valence <hdevalence at gmail.com>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -24,6 +23,12 @@
 #include "projector.h"
 
 
+/**
+ * @class AzimuthalEquidistantProjector
+ *
+ * Implememntation of <a href="http://en.wikipedia.org/wiki/Azimuthal_equidistant_projection">Azimuthal equidistant projection</a>
+ *
+ */
 class AzimuthalEquidistantProjector : public Projector
 {
 
diff --git a/kstars/projections/equirectangularprojector.cpp b/kstars/projections/equirectangularprojector.cpp
index 9fd567e..b77c23f 100644
--- a/kstars/projections/equirectangularprojector.cpp
+++ b/kstars/projections/equirectangularprojector.cpp
@@ -1,6 +1,5 @@
 /*
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
+    Copyright (C) 2010 Henry de Valence <hdevalence at gmail.com>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
diff --git a/kstars/projections/equirectangularprojector.h b/kstars/projections/equirectangularprojector.h
index 8a065c3..edff69c 100644
--- a/kstars/projections/equirectangularprojector.h
+++ b/kstars/projections/equirectangularprojector.h
@@ -1,6 +1,5 @@
 /*
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
+    Copyright (C) 2010 Henry de Valence <hdevalence at gmail.com>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -23,7 +22,12 @@
 
 #include "projector.h"
 
-
+/**
+ * @class EquirectangularProjector
+ *
+ * Implememntation of <a href="http://en.wikipedia.org/wiki/Equirectangular_projection">Equirectangular projection</a>
+ *
+ */
 class EquirectangularProjector : public Projector
 {
 public:
diff --git a/kstars/projections/gnomonicprojector.cpp b/kstars/projections/gnomonicprojector.cpp
index d07379a..69bd825 100644
--- a/kstars/projections/gnomonicprojector.cpp
+++ b/kstars/projections/gnomonicprojector.cpp
@@ -1,6 +1,5 @@
 /*
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
+    Copyright (C) 2010 Henry de Valence <hdevalence at gmail.com>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
diff --git a/kstars/projections/gnomonicprojector.h b/kstars/projections/gnomonicprojector.h
index cff8574..d6d9175 100644
--- a/kstars/projections/gnomonicprojector.h
+++ b/kstars/projections/gnomonicprojector.h
@@ -1,6 +1,5 @@
 /*
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
+    Copyright (C) 2010 Henry de Valence <hdevalence at gmail.com>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -23,7 +22,12 @@
 
 #include "projector.h"
 
-
+/**
+ * @class GnomonicProjector
+ *
+ * Implememntation of <a href="http://en.wikipedia.org/wiki/Gnomonic_projection">Gnomonic projection</a>
+ *
+ */
 class GnomonicProjector : public Projector
 {
 
diff --git a/kstars/projections/lambertprojector.cpp b/kstars/projections/lambertprojector.cpp
index a6b92df..c737636 100644
--- a/kstars/projections/lambertprojector.cpp
+++ b/kstars/projections/lambertprojector.cpp
@@ -1,6 +1,5 @@
 /*
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
+    Copyright (C) 2010 Henry de Valence <hdevalence at gmail.com>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
diff --git a/kstars/projections/lambertprojector.h b/kstars/projections/lambertprojector.h
index 33540e8..6fb4b66 100644
--- a/kstars/projections/lambertprojector.h
+++ b/kstars/projections/lambertprojector.h
@@ -1,6 +1,5 @@
 /*
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
+    Copyright (C) 2010 Henry de Valence <hdevalence at gmail.com>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -24,7 +23,12 @@
 #include "projector.h"
 #include "skymap.h"
 
-
+/**
+ * @class LambertProjector
+ *
+ * Implememntation of <a href="http://en.wikipedia.org/wiki/Lambert_azimuthal_equal-area_projection">Lambert azimuthal equal-area projection</a>
+ *
+ */
 class LambertProjector : public Projector
 {
 public:
diff --git a/kstars/projections/orthographicprojector.cpp b/kstars/projections/orthographicprojector.cpp
index b54bafe..240a180 100644
--- a/kstars/projections/orthographicprojector.cpp
+++ b/kstars/projections/orthographicprojector.cpp
@@ -1,6 +1,5 @@
 /*
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
+    Copyright (C) 2010 Henry de Valence <hdevalence at gmail.com>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
diff --git a/kstars/projections/orthographicprojector.h b/kstars/projections/orthographicprojector.h
index 75e5443..9731eb2 100644
--- a/kstars/projections/orthographicprojector.h
+++ b/kstars/projections/orthographicprojector.h
@@ -1,6 +1,5 @@
 /*
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
+    Copyright (C) 2010 Henry de Valence <hdevalence at gmail.com>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -23,7 +22,12 @@
 
 #include "projector.h"
 
-
+/**
+ * @class OrthographicProjector
+ *
+ * Implememntation of <a href="http://en.wikipedia.org/wiki/Orthographic_projection">Orthographic projection</a>
+ *
+ */
 class OrthographicProjector : public Projector
 {
 
diff --git a/kstars/projections/projector.h b/kstars/projections/projector.h
index 1e29d4f..f9c73b7 100644
--- a/kstars/projections/projector.h
+++ b/kstars/projections/projector.h
@@ -45,7 +45,11 @@ public:
     SkyPoint *focus;
 };
 
-/** This class serves as an interface to handle projections. */
+/**
+ * @class Projector
+ *
+ * The Projector class is the primary class that serves as an interface to handle projections.
+ */
 class Projector
 {
 public:
@@ -65,14 +69,14 @@ public:
     /** Return the FOV of this projection */
     double fov() const;
 
-    /**Check if the current point on screen is a valid point on the sky. This is needed
+    /** Check if the current point on screen is a valid point on the sky. This is needed
         *to avoid a crash of the program if the user clicks on a point outside the sky (the
         *corners of the sky map at the lowest zoom level are the invalid points).
         *@param p the screen pixel position
         */
     virtual bool unusablePoint( const QPointF &p ) const;
     
-    /**Given the coordinates of the SkyPoint argument, determine the
+    /** Given the coordinates of the SkyPoint argument, determine the
      * pixel coordinates in the SkyMap.
      *
      * Since most of the projections used by KStars are very similar,
@@ -116,12 +120,12 @@ public:
     virtual SkyPoint fromScreen( const QPointF &p, dms *LST, const dms *lat ) const;
 
 
-    /**ASSUMES *p1 did not clip but *p2 did.  Returns the QPointF on the line
+    /** ASSUMES *p1 did not clip but *p2 did.  Returns the QPointF on the line
      * between *p1 and *p2 that just clips.
      */
     QPointF clipLine( SkyPoint *p1, SkyPoint *p2 ) const;
 
-    /**ASSUMES *p1 did not clip but *p2 did.  Returns the Vector2f on the line
+    /** ASSUMES *p1 did not clip but *p2 did.  Returns the Vector2f on the line
      * between *p1 and *p2 that just clips.
      */
     Vector2f clipLineVec( SkyPoint *p1, SkyPoint *p2 ) const;
@@ -178,7 +182,7 @@ public:
      */
     bool checkVisibility( SkyPoint *p ) const;
 
-    /**Determine the on-screen position angle of a SkyObject.  This is the sum
+    /** Determine the on-screen position angle of a SkyObject.  This is the sum
      * of the object's sky position angle (w.r.t. North), and the position angle
      * of "North" at the position of the object (w.r.t. the screen Y-axis).
      * The latter is determined by constructing a test point with the same RA but
diff --git a/kstars/projections/stereographicprojector.cpp b/kstars/projections/stereographicprojector.cpp
index d565829..794740e 100644
--- a/kstars/projections/stereographicprojector.cpp
+++ b/kstars/projections/stereographicprojector.cpp
@@ -1,6 +1,5 @@
 /*
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
+    Copyright (C) 2010 Henry de Valence <hdevalence at gmail.com>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
diff --git a/kstars/projections/stereographicprojector.h b/kstars/projections/stereographicprojector.h
index 8259b56..f1150cc 100644
--- a/kstars/projections/stereographicprojector.h
+++ b/kstars/projections/stereographicprojector.h
@@ -1,6 +1,5 @@
 /*
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
+    Copyright (C) 2010 Henry de Valence <hdevalence at gmail.com>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -23,7 +22,12 @@
 
 #include "projector.h"
 
-
+/**
+ * @class StereographicProjector
+ *
+ * Implememntation of <a href="http://en.wikipedia.org/wiki/Stereographic_projection">Stereographic projection</a>
+ *
+ */
 class StereographicProjector : public Projector
 {

More information about the Kstars-devel mailing list