[Kstars-devel] [kstars] /: Massive API documentation update and fixes. This is still a work in progress and will take somewhere between few weeks to few months before it is in a decent state. Any new code
Jasem Mutlaq
mutlaqja at ikarustech.com
Tue Feb 10 22:07:10 UTC 2015
Git commit 5963ce79782e3b297dc155b8b63a504c2155570d by Jasem Mutlaq.
Committed on 10/02/2015 at 22:05.
Pushed by mutlaqja into branch 'master'.
Massive API documentation update and fixes. This is still a work in progress and will take somewhere between few weeks to few months before it is in a decent state. Any new code
MUST adhere to doxygen documentation standards before it can be accepted in KStars.
CCMAIL:kstars-devel at kde.org
M +3 -3 Mainpage.dox
M +1 -2 datahandlers/ksparser.cpp
M +8 -8 kstars/colorscheme.h
M +3 -2 kstars/dialogs/addlinkdialog.cpp
M +9 -9 kstars/dialogs/detaildialog.h
M +2 -2 kstars/dialogs/exportimagedialog.h
M +3 -3 kstars/dialogs/finddialog.h
M +4 -4 kstars/dialogs/focusdialog.h
M +2 -2 kstars/dialogs/fovdialog.h
M +7 -7 kstars/dialogs/locationdialog.h
M +4 -4 kstars/dialogs/timedialog.h
M +5 -3 kstars/dms.cpp
M +30 -30 kstars/dms.h
M +1 -1 kstars/fov.h
M +36 -36 kstars/geolocation.h
M +16 -15 kstars/htmesh/HTMesh.h
M +7 -7 kstars/htmesh/MeshBuffer.h
M +5 -5 kstars/htmesh/MeshIterator.h
M +3 -4 kstars/htmesh/SkipListElement.h
M +1 -2 kstars/htmesh/SpatialIndex.h
M +3 -4 kstars/htmesh/SpatialVector.h
M +1 -1 kstars/imageexporter.h
M +7 -7 kstars/imageviewer.h
M +9 -9 kstars/ksfilereader.h
M +19 -19 kstars/ksnumbers.h
M +11 -11 kstars/kspopupmenu.h
M +1 -1 kstars/kstars.h
M +10 -10 kstars/kstarsdata.h
M +1 -1 kstars/kstarsdatetime.h
M +3 -3 kstars/kstarssplash.h
M +1 -1 kstars/ksutils.h
M +5 -5 kstars/kswizard.h
M +15 -15 kstars/oal/execute.h
M +3 -3 kstars/obslistpopupmenu.h
M +1 -1 kstars/options/opsadvanced.h
M +1 -1 kstars/options/opscolors.h
M +1 -1 kstars/options/opssatellites.h
M +1 -1 kstars/options/opssolarsystem.h
M +1 -1 kstars/options/opssupernovae.h
M +2 -2 kstars/projections/projector.h
M +10 -10 kstars/simclock.h
M +2 -2 kstars/skycomponents/asteroidscomponent.h
M +1 -1 kstars/skycomponents/catalogcomponent.h
M +2 -2 kstars/skycomponents/cometscomponent.h
M +2 -2 kstars/skycomponents/constellationboundarylines.h
M +4 -4 kstars/skycomponents/constellationlines.h
M +3 -3 kstars/skycomponents/constellationnamescomponent.h
M +1 -1 kstars/skycomponents/culturelist.h
M +1 -1 kstars/skycomponents/deepskycomponent.h
M +1 -1 kstars/skycomponents/ecliptic.h
M +1 -1 kstars/skycomponents/equator.h
M +16 -16 kstars/skycomponents/flagcomponent.h
M +8 -8 kstars/skycomponents/highpmstarlist.h
M +18 -18 kstars/skycomponents/linelistindex.h
M +3 -3 kstars/skycomponents/linelistlabel.h
M +1 -1 kstars/skycomponents/listcomponent.h
M +6 -6 kstars/skycomponents/milkyway.h
M +4 -4 kstars/skycomponents/noprecessindex.h
M +1 -1 kstars/skycomponents/planetmoonscomponent.h
M +1 -1 kstars/skycomponents/pointlistcomponent.h
M +6 -6 kstars/skycomponents/skycomponent.h
M +7 -7 kstars/skycomponents/skycomposite.h
M +1 -1 kstars/skycomponents/skymapcomposite.h
M +53 -41 kstars/skycomponents/skymesh.h
M +1 -1 kstars/skycomponents/solarsystemcomposite.h
M +1 -1 kstars/skycomponents/solarsystemlistcomponent.h
M +1 -1 kstars/skycomponents/starblocklist.cpp
M +4 -4 kstars/skycomponents/starcomponent.h
M +38 -38 kstars/skymap.h
M +4 -4 kstars/skymapdrawabstract.h
M +6 -6 kstars/skyobjects/ksasteroid.h
M +5 -5 kstars/skyobjects/kscomet.h
M +6 -6 kstars/skyobjects/ksmoon.h
M +11 -11 kstars/skyobjects/ksplanet.h
M +16 -16 kstars/skyobjects/ksplanetbase.h
M +3 -3 kstars/skyobjects/kspluto.h
M +5 -5 kstars/skyobjects/kssun.h
M +2 -2 kstars/skyobjects/skyline.h
M +32 -32 kstars/skyobjects/skypoint.h
M +21 -21 kstars/skyobjects/starobject.h
M +1 -1 kstars/thumbnailpicker.h
M +17 -17 kstars/timezonerule.h
M +14 -14 kstars/tools/altvstime.h
M +1 -1 kstars/tools/astrocalc.h
M +1 -1 kstars/tools/avtplotwidget.h
M +1 -1 kstars/tools/calendarwidget.h
M +1 -1 kstars/tools/flagmanager.h
M +1 -1 kstars/tools/jmoontool.h
M +1 -1 kstars/tools/modcalcangdist.h
M +1 -1 kstars/tools/modcalcvlsr.h
M +53 -53 kstars/tools/observinglist.h
M +6 -6 kstars/tools/obslistwizard.h
M +1 -1 kstars/tools/planetviewer.h
M +1 -1 kstars/tools/scriptbuilder.h
M +16 -16 kstars/tools/wutdialog.h
M +1 -1 kstars/widgets/clicklabel.h
M +3 -3 kstars/widgets/dmsbox.h
M +3 -3 kstars/widgets/draglistbox.h
M +7 -2 kstars/widgets/infoboxwidget.h
M +1 -1 kstars/widgets/logedit.h
M +1 -1 kstars/widgets/magnitudespinbox.h
M +1 -1 kstars/widgets/mapcanvas.h
M +2 -2 kstars/widgets/timespinbox.h
M +3 -3 kstars/widgets/timestepbox.h
M +6 -6 kstars/widgets/timeunitbox.h
http://commits.kde.org/kstars/5963ce79782e3b297dc155b8b63a504c2155570d
diff --git a/Mainpage.dox b/Mainpage.dox
index c6ea88c..38b3b98 100644
--- a/Mainpage.dox
+++ b/Mainpage.dox
@@ -21,7 +21,7 @@ The "model" is encapsulated in the KStarsData class, and the "view" is encapsula
\subsection Data Data
- KStarsData (master class for the backend "model")
- SkyMapComposite (top of hierarchy for plottable objects)
- - SkyComponents 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.
+ - 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
- SkyObject itself has many derivatives for different kinds of objects:
@@ -46,8 +46,8 @@ The "model" is encapsulated in the KStarsData class, and the "view" is encapsula
- KSPopupMenu (right-click menu)
- InfoBoxes (on-screen information on time, position, and focused object)
- SkyLabeler
- - Flags
- - FOVs
+ - 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
\subsection Time Time
diff --git a/datahandlers/ksparser.cpp b/datahandlers/ksparser.cpp
index 7e648f1..a45f4f1 100644
--- a/datahandlers/ksparser.cpp
+++ b/datahandlers/ksparser.cpp
@@ -223,8 +223,7 @@ bool KSParser::HasNextRow() {
}
void KSParser::SetProgress(QString msg, int total_lines, int step_size) {
- file_reader_.setProgress(i18n("Loading NGC/IC objects"),
- total_lines, step_size);
+ file_reader_.setProgress(msg, total_lines, step_size);
}
void KSParser::ShowProgress() {
diff --git a/kstars/colorscheme.h b/kstars/colorscheme.h
index d8e78d2..ffff1a6 100644
--- a/kstars/colorscheme.h
+++ b/kstars/colorscheme.h
@@ -45,7 +45,7 @@ public:
/** @return true if the Palette contains the given key name */
bool hasColorNamed( const QString &name ) const { return ( Palette.contains( name ) ); }
- /**@short Retrieve a color by name.
+ /** @short Retrieve a color by name.
* @p name the key name of the color to be retrieved.
* @return the requested color, or Qt::white if color name not found.
*/
@@ -56,40 +56,40 @@ public:
*/
QColor colorAt( int i ) const;
- /**@p i the index of the long name to retrieve
+ /** @p i the index of the long name to retrieve
* @return the name of the color at index i
*/
QString nameAt( int i ) const;
- /**@p i the index of the key name to retrieve
+ /** @p i the index of the key name to retrieve
* @return the key name of the color at index i
*/
QString keyAt( int i ) const;
- /**@return the long name of the color whose key name is given
+ /** @return the long name of the color whose key name is given
* @p key the key name identifying the color.
*/
QString nameFromKey( const QString &key ) const;
- /**Change the color with the given key to the given value
+ /** Change the color with the given key to the given value
* @p key the key-name of the color to be changed
* @p color the new color value
*/
void setColor( const QString &key, const QString &color );
- /**Load a color scheme from a *.colors file
+ /** Load a color scheme from a *.colors file
* @p filename the filename of the color scheme to be loaded.
* @return true if the scheme was successfully loaded
*/
bool load( const QString &filename );
- /**Save the current color scheme to a *.colors file.
+ /** Save the current color scheme to a *.colors file.
* @p name the filename to create
* @return true if the color scheme is successfully writeen to a file
*/
bool save( const QString &name );
- /**@return the Filename associated with the color scheme. */
+ /** @return the Filename associated with the color scheme. */
QString fileName() const { return FileName; }
/** Read color-scheme data from the Config object. */
diff --git a/kstars/dialogs/addlinkdialog.cpp b/kstars/dialogs/addlinkdialog.cpp
index 2e5435a..a0dd1fd 100644
--- a/kstars/dialogs/addlinkdialog.cpp
+++ b/kstars/dialogs/addlinkdialog.cpp
@@ -19,6 +19,7 @@
#include <QPushButton>
#include <QUrl>
+#include <QDesktopServices>
#include <KMessageBox>
#include <KToolInvocation>
@@ -56,12 +57,12 @@ AddLinkDialog::AddLinkDialog( QWidget *parent, const QString &oname )
void AddLinkDialog::checkURL( void ) {
QUrl _url ( url() );
if ( _url.isValid() ) { //Is the string a valid URL?
- KToolInvocation::invokeBrowser( _url.url() ); //If so, launch the browser to see if it's the correct document
+ QDesktopServices::openUrl(_url.url() ); //If so, launch the browser to see if it's the correct document
} else { //If not, print a warning message box that offers to open the browser to a search engine.
QString message = xi18n( "The URL is not valid. Would you like to open a browser window\nto the Google search engine?" );
QString caption = xi18n( "Invalid URL" );
if ( KMessageBox::warningYesNo( 0, message, caption, KGuiItem(xi18n("Browse Google")), KGuiItem(xi18n("Do Not Browse")) )==KMessageBox::Yes ) {
- KToolInvocation::invokeBrowser( "http://www.google.com" );
+ QDesktopServices::openUrl( QUrl("http://www.google.com") );
}
}
}
diff --git a/kstars/dialogs/detaildialog.h b/kstars/dialogs/detaildialog.h
index 26a4aa4..2952e39 100644
--- a/kstars/dialogs/detaildialog.h
+++ b/kstars/dialogs/detaildialog.h
@@ -100,30 +100,30 @@ public:
inline QPixmap* thumbnail() { return Thumbnail; }
public slots:
- /**@short Slot to add this object to the observing list.
+ /** @short Slot to add this object to the observing list.
*/
void addToObservingList();
- /**@short Slot to center this object in the display.
+ /** @short Slot to center this object in the display.
*/
void centerMap();
- /**@short Slot to center this object in the telescope.
+ /** @short Slot to center this object in the telescope.
*/
void centerTelescope();
//TODO: showThumbnail() is only called in the ctor; make it private and not a slot.
- /**@short Slot to display the thumbnail image for the object
+ /** @short Slot to display the thumbnail image for the object
*/
void showThumbnail();
- /**@short Slot to update thumbnail image for the object, using the Thumbnail
+ /** @short Slot to update thumbnail image for the object, using the Thumbnail
*Picker tool.
*@sa ThumbnailPicker
*/
void updateThumbnail();
- /**@short Slot for viewing the selected image or info URL in the web browser.
+ /** @short Slot for viewing the selected image or info URL in the web browser.
*/
void viewLink();
@@ -141,17 +141,17 @@ public slots:
*/
void setCurrentLink(QListWidgetItem *it);
- /**@short Rebuild the Image and Info URL lists for this object.
+ /** @short Rebuild the Image and Info URL lists for this object.
*@note used when an item is added to either list.
*/
void updateLists();
- /**@short Open a dialog to edit a URL in either the Images or Info lists,
+ /** @short Open a dialog to edit a URL in either the Images or Info lists,
*and update the user's *url.dat file.
*/
void editLinkDialog();
- /**@short remove a URL entry from either the Images or Info lists, and
+ /** @short remove a URL entry from either the Images or Info lists, and
*update the user's *url.dat file.
*/
void removeLinkDialog();
diff --git a/kstars/dialogs/exportimagedialog.h b/kstars/dialogs/exportimagedialog.h
index 476e4d1..78617d0 100644
--- a/kstars/dialogs/exportimagedialog.h
+++ b/kstars/dialogs/exportimagedialog.h
@@ -39,7 +39,7 @@ public:
};
-/**@short Export sky image dialog. This dialog enables user to set up basic legend
+/** @short Export sky image dialog. This dialog enables user to set up basic legend
properties before image is exported.
*/
class ExportImageDialog : public QDialog
@@ -55,7 +55,7 @@ public:
*/
ExportImageDialog(const QString &url, const QSize &size, ImageExporter *imgExporter = 0);
- /**@short Default destructor. */
+ /** @short Default destructor. */
~ExportImageDialog() { }
inline void setOutputUrl(const QString &url) { m_Url = url; }
diff --git a/kstars/dialogs/finddialog.h b/kstars/dialogs/finddialog.h
index da59a31..1a3f488 100644
--- a/kstars/dialogs/finddialog.h
+++ b/kstars/dialogs/finddialog.h
@@ -34,7 +34,7 @@ public:
explicit FindDialogUI( QWidget *parent=0 );
};
-/**@class FindDialog
+/** @class FindDialog
* Dialog window for finding SkyObjects by name. The dialog contains
* a QListBox showing the list of named objects, a QLineEdit for filtering
* the list by name, and a QCombobox for filtering the list by object type.
@@ -92,12 +92,12 @@ protected:
private:
- /**@short Do some post processing on the search text to interpret what the user meant
+ /** @short Do some post processing on the search text to interpret what the user meant
* This could include replacing text like "m93" with "m 93"
*/
QString processSearchText();
- /**@short pre-filter the list of objects according to the
+ /** @short pre-filter the list of objects according to the
* selected object type.
*/
void filterByType();
diff --git a/kstars/dialogs/focusdialog.h b/kstars/dialogs/focusdialog.h
index e9f660d..8f86111 100644
--- a/kstars/dialogs/focusdialog.h
+++ b/kstars/dialogs/focusdialog.h
@@ -32,7 +32,7 @@ public:
};
-/**@class FocusDialog
+/** @class FocusDialog
*@short A small dialog for setting the focus coordinates manually.
*@author Jason Harris
*@version 1.0
@@ -46,13 +46,13 @@ public:
/**Destructor (empty). */
~FocusDialog();
- /**@return pointer to the SkyPoint described by the entered RA, Dec */
+ /** @return pointer to the SkyPoint described by the entered RA, Dec */
inline SkyPoint& point() { return Point; }
- /**@return suggested size of focus window. */
+ /** @return suggested size of focus window. */
QSize sizeHint() const;
- /**@return whether user set the AltAz coords */
+ /** @return whether user set the AltAz coords */
inline bool usedAltAz() const { return UsedAltAz; }
/**
diff --git a/kstars/dialogs/fovdialog.h b/kstars/dialogs/fovdialog.h
index 1d709ff..44ec609 100644
--- a/kstars/dialogs/fovdialog.h
+++ b/kstars/dialogs/fovdialog.h
@@ -26,7 +26,7 @@
#include "ui_fovdialog.h"
#include "ui_newfov.h"
-/**@class FOVDialog Dialog to select a Field-of-View indicator (or create a new one)
+/** @class FOVDialog Dialog to select a Field-of-View indicator (or create a new one)
*@author Jason Harris
*@version 1.0
*/
@@ -66,7 +66,7 @@ private:
static int fovID;
};
-/**@class NewFOV Dialog for defining a new FOV symbol
+/** @class NewFOV Dialog for defining a new FOV symbol
*@author Jason Harris
*@version 1.0
*/
diff --git a/kstars/dialogs/locationdialog.h b/kstars/dialogs/locationdialog.h
index c3baf1d..bc0034e 100644
--- a/kstars/dialogs/locationdialog.h
+++ b/kstars/dialogs/locationdialog.h
@@ -18,7 +18,7 @@
#ifndef LOCATIONDIALOG_H_
#define LOCATIONDIALOG_H_
-/**@class LocationDialog
+/** @class LocationDialog
*Dialog for changing the geographic location of the observer. The
*dialog is divided into two sections.
*
@@ -77,10 +77,10 @@ public:
*/
void initCityList( void );
- /**@return pointer to the highlighted city in the List. */
+ /** @return pointer to the highlighted city in the List. */
GeoLocation* selectedCity() const { return SelectedCity; }
- /**@return pointer to the List of filtered city pointers. */
+ /** @return pointer to the List of filtered city pointers. */
QList<GeoLocation*> filteredList() { return filteredCityList; }
/**
@@ -90,16 +90,16 @@ public:
*/
void findCitiesNear( int longitude, int latitude );
- /**@return the city name of the selected location. */
+ /** @return the city name of the selected location. */
QString selectedCityName( void ) const { return SelectedCity->translatedName(); }
- /**@return the province name of the selected location. */
+ /** @return the province name of the selected location. */
QString selectedProvinceName( void ) const { return SelectedCity->translatedProvince(); }
- /**@return the country name of the selected location. */
+ /** @return the country name of the selected location. */
QString selectedCountryName( void ) const { return SelectedCity->translatedCountry(); }
- /**@return true if the AddCityBUtton is enabled */
+ /** @return true if the AddCityBUtton is enabled */
bool addCityEnabled();
public slots:
diff --git a/kstars/dialogs/timedialog.h b/kstars/dialogs/timedialog.h
index f4d7a6a..19cfb50 100644
--- a/kstars/dialogs/timedialog.h
+++ b/kstars/dialogs/timedialog.h
@@ -34,7 +34,7 @@ class QTimeEdit;
class QPushButton;
class GeoLocation;
-/**@class TimeDialog
+/** @class TimeDialog
*A class for adjusting the Time and Date. Contains a KDatePicker widget
*for selecting the date, and a QTimeEdit for selecting the time. There
*is also a "Now" button for selecting the Time and Date from the system clock.
@@ -57,15 +57,15 @@ public:
*/
~TimeDialog() {}
- /**@returns a QTime object with the selected time
+ /** @returns a QTime object with the selected time
*/
QTime selectedTime( void );
- /**@returns a QDate object with the selected date
+ /** @returns a QDate object with the selected date
*/
QDate selectedDate( void );
- /**@returns a KStarsDateTime object with the selected date and time
+ /** @returns a KStarsDateTime object with the selected date and time
*/
KStarsDateTime selectedDateTime( void );
diff --git a/kstars/dms.cpp b/kstars/dms.cpp
index c84a66b..9ce0a28 100644
--- a/kstars/dms.cpp
+++ b/kstars/dms.cpp
@@ -224,12 +224,14 @@ const QString dms::toHMSString() const {
dms dms::fromString(const QString &st, bool deg) {
dms result;
- bool ok( false );
+ result.setFromString( st, deg );
+ return result;
+ //bool ok( false );
- ok = result.setFromString( st, deg );
+ //ok = result.setFromString( st, deg );
// if ( ok )
- return result;
+ //return result;
// else {
// kDebug() << xi18n( "Could Not Set Angle from string: " ) << st;
// return result;
diff --git a/kstars/dms.h b/kstars/dms.h
index 7a7a2bf..e47b931 100644
--- a/kstars/dms.h
+++ b/kstars/dms.h
@@ -25,7 +25,7 @@
#include <cmath>
#include "nan.h"
-/**@class dms
+/** @class dms
* @short An angle, stored as degrees, but expressible in many ways.
* @author Jason Harris
* @version 1.0
@@ -44,7 +44,7 @@ public:
/** Default constructor. */
dms() : D( NaN::d ) {}
- /**@short Set the floating-point value of the angle according to the four integer arguments.
+ /** @short Set the floating-point value of the angle according to the four integer arguments.
* @param d degree portion of angle (int). Defaults to zero.
* @param m arcminute portion of angle (int). Defaults to zero.
* @param s arcsecond portion of angle (int). Defaults to zero.
@@ -52,14 +52,14 @@ public:
*/
explicit dms( const int &d, const int &m=0, const int &s=0, const int &ms=0 ) { setD( d, m, s, ms ); }
- /**@short Construct an angle from a double value.
+ /** @short Construct an angle from a double value.
*
* Creates an angle whose value in Degrees is equal to the argument.
* @param x angle expressed as a floating-point number (in degrees)
*/
explicit dms( const double &x ) : D(x) {}
- /**@short Construct an angle from a string representation.
+ /** @short Construct an angle from a string representation.
*
* Attempt to create the angle according to the string argument. If the string
* cannot be parsed as an angle value, the angle is set to zero.
@@ -74,62 +74,62 @@ public:
*/
explicit dms( const QString &s, bool isDeg=true ) { setFromString( s, isDeg ); }
- /**@return integer degrees portion of the angle
+ /** @return integer degrees portion of the angle
*/
inline int degree() const { return int( D ) ; }
- /**@return integer arcminutes portion of the angle.
+ /** @return integer arcminutes portion of the angle.
* @note an arcminute is 1/60 degree.
*/
int arcmin() const;
- /**@return integer arcseconds portion of the angle
+ /** @return integer arcseconds portion of the angle
* @note an arcsecond is 1/60 arcmin, or 1/3600 degree.
*/
int arcsec() const;
- /**@return integer milliarcseconds portion of the angle
+ /** @return integer milliarcseconds portion of the angle
* @note a milliarcsecond is 1/1000 arcsecond.
*/
int marcsec() const;
- /**@return angle in degrees expressed as a double.
+ /** @return angle in degrees expressed as a double.
*/
inline const double& Degrees() const { return D; }
- /**@return integer hours portion of the angle
+ /** @return integer hours portion of the angle
* @note an angle can be measured in degrees/arcminutes/arcseconds
* or hours/minutes/seconds. An hour is equal to 15 degrees.
*/
inline int hour() const { return int( reduce().Degrees()/15.0 ); }
- /**@return integer minutes portion of the angle
+ /** @return integer minutes portion of the angle
* @note a minute is 1/60 hour (not the same as an arcminute)
*/
int minute() const;
- /**@return integer seconds portion of the angle
+ /** @return integer seconds portion of the angle
* @note a second is 1/3600 hour (not the same as an arcsecond)
*/
int second() const;
- /**@return integer milliseconds portion of the angle
+ /** @return integer milliseconds portion of the angle
* @note a millisecond is 1/1000 second (not the same as a milliarcsecond)
*/
int msecond() const;
- /**@return angle in hours expressed as a double.
+ /** @return angle in hours expressed as a double.
* @note an angle can be measured in degrees/arcminutes/arcseconds
* or hours/minutes/seconds. An hour is equal to 15 degrees.
*/
inline double Hours() const { return reduce().Degrees()/15.0; }
- /**Sets floating-point value of angle, in degrees.
+ /** Sets floating-point value of angle, in degrees.
* @param x new angle (double)
*/
void setD( const double &x ) { D = x; }
- /**@short Sets floating-point value of angle, in degrees.
+ /** @short Sets floating-point value of angle, in degrees.
*
* This is an overloaded member function; it behaves essentially
* like the above function. The floating-point value of the angle
@@ -145,7 +145,7 @@ public:
*/
void setD( const int &d, const int &m, const int &s, const int &ms=0 );
- /**@short Sets floating-point value of angle, in hours.
+ /** @short Sets floating-point value of angle, in hours.
*
* Converts argument from hours to degrees, then
* sets floating-point value of angle, in degrees.
@@ -154,7 +154,7 @@ public:
*/
void setH( const double &x );
- /**@short Sets floating-point value of angle, in hours.
+ /** @short Sets floating-point value of angle, in hours.
*
* Converts argument values from hours to degrees, then
* sets floating-point value of angle, in degrees.
@@ -168,7 +168,7 @@ public:
*/
void setH( const int &h, const int &m, const int &s, const int &ms=0 );
- /**@short Attempt to parse the string argument as a dms value, and set the dms object
+ /** @short Attempt to parse the string argument as a dms value, and set the dms object
* accordingly.
* @param s the string to be parsed as a dms value. The string can be an int or
* floating-point value, or a triplet of values (d/h, m, s) separated by spaces or colons.
@@ -178,7 +178,7 @@ public:
*/
bool setFromString( const QString &s, bool isDeg=true );
- /**@short Compute Sine and Cosine of the angle simultaneously.
+ /** @short Compute Sine and Cosine of the angle simultaneously.
* On machines using glibc >= 2.1, calling SinCos() is somewhat faster
* than calling sin() and cos() separately.
* The values are returned through the arguments (passed by reference).
@@ -189,26 +189,26 @@ public:
*/
inline void SinCos( double &s, double &c ) const;
- /**@short Compute the Angle's Sine.
+ /** @short Compute the Angle's Sine.
*
* @return the Sine of the angle.
* @sa cos()
*/
double sin() const { return ::sin(D*DegToRad); }
- /**@short Compute the Angle's Cosine.
+ /** @short Compute the Angle's Cosine.
*
* @return the Cosine of the angle.
* @sa sin()
*/
double cos() const { return ::cos(D*DegToRad); }
- /**@short Express the angle in radians.
+ /** @short Express the angle in radians.
* @return the angle in radians (double)
*/
double radians() const { return D*DegToRad; }
- /**@short Set angle according to the argument, in radians.
+ /** @short Set angle according to the argument, in radians.
*
* This function converts the argument to degrees, then sets the angle
* with setD().
@@ -216,32 +216,32 @@ public:
*/
void setRadians( const double &a );
- /**return the equivalent angle between 0 and 360 degrees.
+ /** return the equivalent angle between 0 and 360 degrees.
* @warning does not change the value of the parent angle itself.
*/
const dms reduce() const;
- /**@return a nicely-formatted string representation of the angle
+ /** @return a nicely-formatted string representation of the angle
* in degrees, arcminutes, and arcseconds.
*/
const QString toDMSString(const bool forceSign = false) const;
- /**@return a nicely-formatted string representation of the angle
+ /** @return a nicely-formatted string representation of the angle
* in hours, minutes, and seconds.
*/
const QString toHMSString() const;
- /**PI is a const static member; it's public so that it can be used anywhere,
+ /** PI is a const static member; it's public so that it can be used anywhere,
* as long as dms.h is included.
*/
static const double PI;
- /**DegToRad is a const static member equal to the number of radians in
+ /** DegToRad is a const static member equal to the number of radians in
* one degree (dms::PI/180.0).
*/
static const double DegToRad;
- /**@short Static function to create a DMS object from a QString.
+ /** @short Static function to create a DMS object from a QString.
*
* There are several ways to specify the angle:
* @li Integer numbers ( 5 or -33 )
diff --git a/kstars/fov.h b/kstars/fov.h
index 1e4a90a..613702e 100644
--- a/kstars/fov.h
+++ b/kstars/fov.h
@@ -27,7 +27,7 @@
class QPainter;
-/**@class FOV A simple class encapsulating a Field-of-View symbol
+/** @class FOV A simple class encapsulating a Field-of-View symbol
*@author Jason Harris
*@version 1.0
*/
diff --git a/kstars/geolocation.h b/kstars/geolocation.h
index 0f3d904..c0b140a 100644
--- a/kstars/geolocation.h
+++ b/kstars/geolocation.h
@@ -26,7 +26,7 @@
#include "timezonerule.h"
#include "kstarsdatetime.h"
-/**@class GeoLocation
+/** @class GeoLocation
* Contains all relevant information for specifying a location
* on Earth: City Name, State/Province name, Country Name,
* Longitude, Latitude, Elevation, Time Zone, and Daylight Savings
@@ -38,7 +38,7 @@
*/
class GeoLocation {
public:
- /**Constructor using dms objects to specify longitude and latitude.
+ /** Constructor using dms objects to specify longitude and latitude.
* @param lng the longitude
* @param lat the latitude
* @param name the name of the city/town/location
@@ -56,7 +56,7 @@ public:
const QString &country="Nowhere",
double TZ=0, TimeZoneRule *TZrule=NULL, bool readOnly=false, int iEllips=4, double hght=-10 );
- /**Constructor using doubles to specify X, Y and Z referred to the center of the Earth.
+ /** Constructor using doubles to specify X, Y and Z referred to the center of the Earth.
* @param x the x-position, in m
* @param y the y-position, in m
* @param z the z-position, in m
@@ -74,73 +74,73 @@ public:
const QString &country="Nowhere",
double TZ=0, TimeZoneRule *TZrule=NULL, bool readOnly=false, int iEllips=4 );
- /**@return pointer to the longitude dms object */
+ /** @return pointer to the longitude dms object */
const dms* lng() const { return &Longitude; }
- /**@return pointer to the latitude dms object */
+ /** @return pointer to the latitude dms object */
const dms* lat() const { return &Latitude; }
- /**@return elevation above seal level (meters) */
+ /** @return elevation above seal level (meters) */
double height() const { return Height; }
- /**@return X position in m */
+ /** @return X position in m */
double xPos() const { return PosCartX; }
- /**@return Y position in m */
+ /** @return Y position in m */
double yPos() const { return PosCartY; }
- /**@return Z position in m */
+ /** @return Z position in m */
double zPos() const { return PosCartZ; }
- /**@return index identifying the geodetic ellipsoid model */
+ /** @return index identifying the geodetic ellipsoid model */
int ellipsoid() const { return indexEllipsoid; }
- /**@return untranslated City name */
+ /** @return untranslated City name */
QString name() const { return Name; }
- /**@return translated City name */
+ /** @return translated City name */
QString translatedName() const;
- /**@return untranslated Province name */
+ /** @return untranslated Province name */
QString province() const { return Province; }
- /**@return translated Province name */
+ /** @return translated Province name */
QString translatedProvince() const;
- /**@return untranslated Country name */
+ /** @return untranslated Country name */
QString country() const { return Country; }
- /**@return translated Country name */
+ /** @return translated Country name */
QString translatedCountry() const;
- /**@return comma-separated city, province, country names (each localized) */
+ /** @return comma-separated city, province, country names (each localized) */
QString fullName() const;
- /**@return time zone without DST correction */
+ /** @return time zone without DST correction */
double TZ0() const { return TimeZone; }
- /**@return time zone, including any DST correction. */
+ /** @return time zone, including any DST correction. */
double TZ() const { if( TZrule ) return TimeZone + TZrule->deltaTZ(); return TimeZone; }
- /**@return pointer to time zone rule object */
+ /** @return pointer to time zone rule object */
TimeZoneRule* tzrule() { return TZrule; }
- /**Set Time zone.
+ /** Set Time zone.
* @param value the new time zone */
void setTZ(double value) { TimeZone = value;}
- /**Set Time zone rule.
+ /** Set Time zone rule.
* @param value pointer to the new time zone rule */
void setTZRule(TimeZoneRule* value) { TZrule = value; }
- /**Set longitude according to dms argument.
+ /** Set longitude according to dms argument.
* @param l the new longitude */
void setLong( dms l ) {
Longitude = l;
geodToCart();
}
- /**Set latitude according to dms argument.
+ /** Set latitude according to dms argument.
* @param l the new latitude
*/
void setLat( dms l ) {
@@ -148,7 +148,7 @@ public:
geodToCart();
}
- /**Set elevation above sea level
+ /** Set elevation above sea level
* @param hg the new elevation (meters)
*/
void setHeight( double hg ) {
@@ -156,21 +156,21 @@ public:
geodToCart();
}
- /**Set X
+ /** Set X
* @param x the new x-position (meters)
*/
void setXPos( double x ) {
PosCartX = x;
cartToGeod();
}
- /**Set Y
+ /** Set Y
* @param y the new y-position (meters)
*/
void setYPos( double y ) {
PosCartY = y;
cartToGeod();
}
- /**Set Z
+ /** Set Z
* @param z the new z-position (meters)
*/
void setZPos( double z ) {
@@ -178,28 +178,28 @@ public:
cartToGeod();
}
- /**Update Latitude, Longitude and Height according to new ellipsoid. These are
+ /** Update Latitude, Longitude and Height according to new ellipsoid. These are
* computed from XYZ which do NOT change on changing the ellipsoid.
* @param i index to identify the ellipsoid
*/
void changeEllipsoid( int i );
- /**Set City name according to argument.
+ /** Set City name according to argument.
* @param n new city name
*/
void setName( const QString &n ) { Name = n; }
- /**Set Province name according to argument.
+ /** Set Province name according to argument.
* @param n new province name
*/
void setProvince( const QString &n ) { Province = n; }
- /**Set Country name according to argument.
+ /** Set Country name according to argument.
* @param n new country name
*/
void setCountry( const QString &n ) { Country = n; }
- /**Converts from cartesian coordinates in meters to longitude,
+ /** Converts from cartesian coordinates in meters to longitude,
* latitude and height on a standard geoid for the Earth. The
* geoid is characterized by two parameters: the semimajor axis
* and the flattening.
@@ -213,7 +213,7 @@ public:
*/
void cartToGeod();
- /**Converts from longitude, latitude and height on a standard
+ /** Converts from longitude, latitude and height on a standard
* geoid of the Earth to cartesian coordinates in meters. The geoid
* is characterized by two parameters: the semimajor axis and the
* flattening.
@@ -227,7 +227,7 @@ public:
*/
void geodToCart();
- /**The geoid is an elliposid which fits the shape of the Earth. It is
+ /** The geoid is an elliposid which fits the shape of the Earth. It is
* characterized by two parameters: the semimajor axis and the
* flattening.
*
@@ -255,7 +255,7 @@ public:
*/
void TopocentricVelocity(double vtopo[], dms gt);
- /**@Return Local Mean Sidereal Time.
+ /** @Return Local Mean Sidereal Time.
* @param jd Julian date
*/
double LMST( double jd );
diff --git a/kstars/htmesh/HTMesh.h b/kstars/htmesh/HTMesh.h
index c3e5063..be30bc7 100644
--- a/kstars/htmesh/HTMesh.h
+++ b/kstars/htmesh/HTMesh.h
@@ -24,7 +24,8 @@ class MeshIterator;
class MeshBuffer;
-/* @class HTMesh was originally intended to be a simple interface to the HTM
+/**
+ * @class HTMesh was originally intended to be a simple interface to the HTM
* library for the KStars project that would hide some of the complexity. But
* it has gained some complexity of its own.
*
@@ -57,7 +58,7 @@ class MeshBuffer;
class HTMesh {
public:
- /* @short constructor.
+ /** @short constructor.
* @param level is passed on to the underlying SpatialIndex
* @param buildLevvel is also passed on to the SpatialIndex
* @param numBuffers controls how many output buffers are created. Don't
@@ -68,12 +69,12 @@ public:
~HTMesh();
- /* @short returns the index of the trixel that contains the specified
+ /** @short returns the index of the trixel that contains the specified
* point.
*/
Trixel index(double ra, double dec) const;
- /* NOTE: The intersect() routines below are all used to find the trixels
+ /** NOTE: The intersect() routines below are all used to find the trixels
* needed to cover a geometric object: circle, line, triangle, and
* quadrilateral. Since the number of trixels needed can be large and is
* not known a priori, you must construct a MeshIterator to iterate over
@@ -97,43 +98,43 @@ public:
BufNum bufNum=0);
- /* @short finds the trixels that cover the specified line segment
+ /** @short finds the trixels that cover the specified line segment
*/
void intersect(double ra1, double dec1, double ra2, double dec2,
BufNum bufNum=0);
- /* @short find the trixels that cover the specified triangle
+ /** @short find the trixels that cover the specified triangle
*/
void intersect(double ra1, double dec1, double ra2, double dec2,
double ra3, double dec3, BufNum bufNum=0);
- /* @short finds the trixels that cover the specified quadrilateral
+ /** @short finds the trixels that cover the specified quadrilateral
*/
void intersect(double ra1, double dec1, double ra2, double dec2,
double ra3, double dec3, double ra4, double dec4,
BufNum bufNum=0);
- /* @short returns the number of trixels in the result buffer bufNum.
+ /** @short returns the number of trixels in the result buffer bufNum.
*/
int intersectSize(BufNum bufNum=0);
- /* @short returns the total number of trixels in the HTM. This number
+ /** @short returns the total number of trixels in the HTM. This number
* is 8 * 4^level.
*/
int size() const { return numTrixels; }
- /* @short returns the mesh level.
+ /** @short returns the mesh level.
*/
int level() const { return m_level; }
- /* @short sets the debug level which is used to print out intermediate
+ /** @short sets the debug level which is used to print out intermediate
* results in the line intersection routine.
*/
void setDebug(int debug) { htmDebug = debug; }
- /* @short returns a pointer to the MeshBuffer specified by bufNum.
+ /** @short returns a pointer to the MeshBuffer specified by bufNum.
* Currently this is only used in the MeshIterator constructor.
*/
MeshBuffer* meshBuffer(BufNum bufNum=0);
@@ -156,12 +157,12 @@ public:
int htmDebug;
- /* @short fills the specified buffer with the intersection results in the
+ /** @short fills the specified buffer with the intersection results in the
* RangeConvex.
*/
bool performIntersection(RangeConvex* convex, BufNum bufNum=0);
- /* @short users can only use the allocated buffers
+ /** @short users can only use the allocated buffers
*/
inline bool validBufNum(BufNum bufNum)
{
@@ -171,7 +172,7 @@ public:
return false;
}
- /* @short used by the line intersection routine. Maybe there is a
+ /** @short used by the line intersection routine. Maybe there is a
* simpler and faster approach that does not require this conversion.
*/
void toXYZ( double ra, double dec, double *x, double *y, double *z);
diff --git a/kstars/htmesh/MeshBuffer.h b/kstars/htmesh/MeshBuffer.h
index fcb5810..acffb97 100644
--- a/kstars/htmesh/MeshBuffer.h
+++ b/kstars/htmesh/MeshBuffer.h
@@ -13,7 +13,7 @@
class HTMesh;
-/* @class MeshBuffer the sole purpose of a MeshBuffer is to hold storage space
+/** @class MeshBuffer the sole purpose of a MeshBuffer is to hold storage space
* for the results of an HTM inetersection and then allow multiple
* MeshIterator's to walk through the result set. The buffer space is allocated
* when the MeshBuffer is created. Mesh buffers will usually hang around for
@@ -29,28 +29,28 @@ class MeshBuffer {
~MeshBuffer();
- /* @short prepare the buffer for a new result set
+ /** @short prepare the buffer for a new result set
*/
void reset() { m_size = m_error = 0; }
- /* @short add trixels to the buffer
+ /** @short add trixels to the buffer
*/
int append(Trixel trixel);
- /* @short the location of the buffer for reading
+ /** @short the location of the buffer for reading
*/
const Trixel* buffer() const { return m_buffer; }
- /* @short the number of trixels in the result set
+ /** @short the number of trixels in the result set
*/
int size() const { return m_size; }
- /* @short returns the number of trixels that would have overflowed the
+ /** @short returns the number of trixels that would have overflowed the
* buffer.
*/
int error() const { return m_error; }
- /* @short fills the buffer with consecutive integers
+ /** @short fills the buffer with consecutive integers
*/
void fill();
diff --git a/kstars/htmesh/MeshIterator.h b/kstars/htmesh/MeshIterator.h
index f78c0dd..7362d54 100644
--- a/kstars/htmesh/MeshIterator.h
+++ b/kstars/htmesh/MeshIterator.h
@@ -13,7 +13,7 @@
class HTMesh;
-/* @class MeshIterator is a very lightweight class used to iterate over the
+/** @class MeshIterator is a very lightweight class used to iterate over the
* result set of an HTMesh intersection. If you want to iterate over the same
* result set multiple times in the same block of code, you don't need to create
* a new MeshIterator, just call the reset() method and then re-use the iterator.
@@ -24,19 +24,19 @@ class MeshIterator {
public:
MeshIterator(HTMesh *mesh, BufNum bufNum=0);
- /* @short true if there are more trixel to iterate over.
+ /** @short true if there are more trixel to iterate over.
*/
bool hasNext() const { return cnt < m_size; }
- /* @short returns the next trixel
+ /** @short returns the next trixel
*/
Trixel next() const { return index[cnt++]; }
- /* @short returns the number of trixels stored
+ /** @short returns the number of trixels stored
*/
int size() const { return m_size; }
- /* @short sets the count back to zero so you can use this iterator
+ /** @short sets the count back to zero so you can use this iterator
* to iterate again over the same result set.
*/
void reset() const { cnt = 0; }
diff --git a/kstars/htmesh/SkipListElement.h b/kstars/htmesh/SkipListElement.h
index fad18a3..b085b0d 100644
--- a/kstars/htmesh/SkipListElement.h
+++ b/kstars/htmesh/SkipListElement.h
@@ -1,13 +1,12 @@
#ifndef _SkipListElement_H
#define _SkipListElement_H
-/*
- File: SkipListElement.h
+/** \file SkipListElement.h
Interface for skip list elements
See William Pugh's paper:
Skip Lists: A Probabilistic Alternative to Balanced Trees
- Author: Bruno Grossniklaus, 13.11.97
- Version: 1.0
+ \author: Bruno Grossniklaus, 13.11.97
+ \version: 1.0
History:
13.11.97; Gro; Version 1.0
*/
diff --git a/kstars/htmesh/SpatialIndex.h b/kstars/htmesh/SpatialIndex.h
index ef001f2..e04d8c0 100644
--- a/kstars/htmesh/SpatialIndex.h
+++ b/kstars/htmesh/SpatialIndex.h
@@ -33,8 +33,7 @@
//#
-/**
- The Spatial Index is a quad tree of spherical triangles. The tree
+/** @class SpatialIndex is a quad tree of spherical triangles. The tree
is built in the following way: Start out with 8 triangles on the
sphere using the 3 main circles to determine them. Then, every
triangle can be decomposed into 4 new triangles by drawing main
diff --git a/kstars/htmesh/SpatialVector.h b/kstars/htmesh/SpatialVector.h
index 1a8baf9..c062ca7 100644
--- a/kstars/htmesh/SpatialVector.h
+++ b/kstars/htmesh/SpatialVector.h
@@ -22,8 +22,7 @@
//########################################################################
/**
-
- The SpatialVector is a 3D vector usually living on the surface of
+ @class SpatialVector is a 3D vector usually living on the surface of
the sphere. The corresponding ra, dec can be obtained if the vector
has unit length. That can be ensured with the normalize() function.
@@ -97,9 +96,9 @@ public:
/// subtraction
SpatialVector operator -(const SpatialVector & ) const;
- /**@name Scalar products with int and float */
+ /** @name Scalar products with int and float */
//@{
- /**@name operator *= */
+ /** @name operator *= */
SpatialVector & operator *=(float64);
SpatialVector & operator *=(int);
friend SpatialVector operator *(float64, const SpatialVector &);
diff --git a/kstars/imageexporter.h b/kstars/imageexporter.h
index b95435d..4928eb9 100644
--- a/kstars/imageexporter.h
+++ b/kstars/imageexporter.h
@@ -34,7 +34,7 @@ class QSize;
*/
class ImageExporter : public QObject {
- Q_OBJECT;
+ Q_OBJECT
public:
diff --git a/kstars/imageviewer.h b/kstars/imageviewer.h
index 473d92e..5939425 100644
--- a/kstars/imageviewer.h
+++ b/kstars/imageviewer.h
@@ -47,7 +47,7 @@ private:
};
-/**@class ImageViewer
+/** @class ImageViewer
* @short Image viewer window for KStars
* @author Thomas Kabelmann
* @version 1.0
@@ -71,19 +71,19 @@ public:
explicit ImageViewer ( QString FileName, QWidget *parent = 0);
- /**Destructor. If there is a partially downloaded image file, delete it.*/
+ /** Destructor. If there is a partially downloaded image file, delete it.*/
~ImageViewer();
private:
- /**Display the downloaded image. Resize the window to fit the image, If the image is
+ /** Display the downloaded image. Resize the window to fit the image, If the image is
* larger than the screen, make the image as large as possible while preserving the
* original aspect ratio */
void showImage( void );
- /**Download the image file pointed to by the URL string. */
+ /** Download the image file pointed to by the URL string. */
void loadImageFromURL( void );
- /**Save the downloaded image to a local file. */
+ /** Save the downloaded image to a local file. */
void saveFile (QUrl &url);
QFile file;
@@ -100,10 +100,10 @@ private:
private slots:
/** Initialize (common part of onstructors) */
void init(QString caption, QString capText);
- /**Make sure download has finished, then make sure file exists, then display the image */
+ /** Make sure download has finished, then make sure file exists, then display the image */
void downloadReady (KJob *);
- /**Saves file to disc. */
+ /** Saves file to disc. */
void saveFileToDisc();
/** Inverts colors **/
diff --git a/kstars/ksfilereader.h b/kstars/ksfilereader.h
index 535a359..3c5300f 100644
--- a/kstars/ksfilereader.h
+++ b/kstars/ksfilereader.h
@@ -26,7 +26,7 @@
//class QFile;
class QString;
-/* @class KSFileReader
+/** @class KSFileReader
* I totally rewrote this because the earlier scheme of reading all the lines of
* a file into a buffer before processing is actually extremely inefficient
* because it makes it impossible to interleave file reading and data processing
@@ -69,7 +69,7 @@ class KSFileReader : public QObject, public QTextStream
public:
- /* @short this is the preferred constructor. You can then use
+ /** @short this is the preferred constructor. You can then use
* the open() method to let this class open the file for you.
*/
explicit KSFileReader( qint64 maxLen=1024 );
@@ -82,7 +82,7 @@ public:
*/
explicit KSFileReader( QFile& file, qint64 maxLen=1024 );
- /* @short opens the file fname from the QStandardPaths::DataLocation directory and uses that
+ /** @short opens the file fname from the QStandardPaths::DataLocation directory and uses that
* file for the QTextStream.
*
* @param fname the name of the file to open
@@ -91,7 +91,7 @@ public:
*/
bool open( const QString& fname );
- /* @short opens the file with full path fname and uses that
+ /** @short opens the file with full path fname and uses that
* file for the QTextStream. open() locates QStandardPaths::DataLocation behind the scenes,
* so passing fname such that
* QString fname = QStandardPaths::locate(QStandardPaths::DataLocation, "file_name" );
@@ -103,12 +103,12 @@ public:
*/
bool openFullPath( const QString& fname );
- /* @return true if we are not yet at the end of the file.
+ /** @return true if we are not yet at the end of the file.
* (I added this to be compatible with existing code.)
*/
bool hasMoreLines() const { return ! QTextStream::atEnd(); }
- /* @short increments the line number and returns the next line from the
+ /** @short increments the line number and returns the next line from the
* file as a QString.
*/
inline QString readLine() {
@@ -116,11 +116,11 @@ public:
return QTextStream::readLine( m_maxLen );
}
- /* @short returns the current line number
+ /** @short returns the current line number
*/
int lineNumber() const { return m_curLine; }
- /* @short Prepares this instance to emit progress reports on how much
+ /** @short Prepares this instance to emit progress reports on how much
* of the file has been read (in percent).
* @param totalLines the number of lines to be read
* @param numUpdates the number of progress reports to send
@@ -129,7 +129,7 @@ public:
unsigned int lastLine,
unsigned int numUpdates=10 );
- /* @short emits progress reports when required and updates bookkeeping
+ /** @short emits progress reports when required and updates bookkeeping
* for when to send the next report. This might seem slow at first
* glance but almost all the time we are just doing an integer compare
* and returning. If you are worried about speed we can inline it.
diff --git a/kstars/ksnumbers.h b/kstars/ksnumbers.h
index 5e0a4bb..b988d89 100644
--- a/kstars/ksnumbers.h
+++ b/kstars/ksnumbers.h
@@ -24,7 +24,7 @@
#include "dms.h"
-/**@class KSNumbers
+/** @class KSNumbers
*
*There are several time-dependent values used in position calculations,
*that are not specific to an object. This class provides
@@ -52,59 +52,59 @@ public:
/**Destructor (empty). */
~KSNumbers();
- /**@return the current Obliquity (the angle of inclination between
+ /** @return the current Obliquity (the angle of inclination between
*the celestial equator and the ecliptic)
*/
const dms* obliquity() const { return &Obliquity; }
- /**@return the constant of aberration (20.49 arcsec). */
+ /** @return the constant of aberration (20.49 arcsec). */
dms constAberr() const { return K; }
- /**@return the mean solar anomaly. */
+ /** @return the mean solar anomaly. */
dms sunMeanAnomaly() const { return M; }
- /**@return the mean solar longitude. */
+ /** @return the mean solar longitude. */
dms sunMeanLongitude() const { return L; }
- /**@return the true solar anomaly. */
+ /** @return the true solar anomaly. */
dms sunTrueAnomaly() const { return M0; }
- /**@return the true solar longitude. */
+ /** @return the true solar longitude. */
dms sunTrueLongitude() const { return L0; }
- /**@return the longitude of the Earth's perihelion point. */
+ /** @return the longitude of the Earth's perihelion point. */
dms earthPerihelionLongitude() const { return P; }
- /**@return eccentricity of Earth's orbit.*/
+ /** @return eccentricity of Earth's orbit.*/
double earthEccentricity() const { return e; }
- /**@return the change in obliquity due to the nutation of
+ /** @return the change in obliquity due to the nutation of
* Earth's orbit. Value is in degrees */
double dObliq() const { return deltaObliquity; }
- /**@return the change in Ecliptic Longitude due to nutation.
+ /** @return the change in Ecliptic Longitude due to nutation.
* Value is in degrees. */
double dEcLong() const { return deltaEcLong; }
- /**@return Julian centuries since J2000*/
+ /** @return Julian centuries since J2000*/
double julianCenturies() const { return T; }
- /**@return Julian Day*/
+ /** @return Julian Day*/
long double julianDay() const { return days; }
- /**@return Julian Millenia since J2000*/
+ /** @return Julian Millenia since J2000*/
double julianMillenia() const { return jm; }
- /**@return element of P1 precession array at position [i1][i2] */
+ /** @return element of P1 precession array at position [i1][i2] */
double p1( int i1, int i2 ) const { return P1[i1][i2]; }
- /**@return element of P2 precession array at position [i1][i2] */
+ /** @return element of P2 precession array at position [i1][i2] */
double p2( int i1, int i2 ) const { return P2[i1][i2]; }
- /**@return element of P1B precession array at position [i1][i2] */
+ /** @return element of P1B precession array at position [i1][i2] */
double p1b( int i1, int i2 ) const { return P1B[i1][i2]; }
- /**@return element of P2B precession array at position [i1][i2] */
+ /** @return element of P2B precession array at position [i1][i2] */
double p2b( int i1, int i2 ) const { return P2B[i1][i2]; }
/**
@@ -112,7 +112,7 @@ public:
*/
void computeConstantValues();
- /**@short update all values for the date given as an argument.
+ /** @short update all values for the date given as an argument.
*@param jd the Julian date for which to compute values
*/
void updateValues( long double jd );
diff --git a/kstars/kspopupmenu.h b/kstars/kspopupmenu.h
index fadfe8b..435caea 100644
--- a/kstars/kspopupmenu.h
+++ b/kstars/kspopupmenu.h
@@ -31,7 +31,7 @@ class KSMoon;
class Satellite;
class Supernova;
-/**@class KSPopupMenu
+/** @class KSPopupMenu
*The KStars Popup Menu. The menu is sensitive to the
*object type of the object which was clicked to invoke the menu.
*Items in the menu include name and type data; rise/transit/set times;
@@ -44,13 +44,13 @@ class KSPopupMenu : public QMenu
{
Q_OBJECT
public:
- /**Default constructor*/
+ /** Default constructor*/
KSPopupMenu();
- /**Destructor (empty)*/
+ /** Destructor (empty)*/
~KSPopupMenu();
- /**Add an item to the popup menu for each of the URL links associated with
+ /** Add an item to the popup menu for each of the URL links associated with
* this object. URL links appear in two categories: images and information pages.
* For some objects, a link to Digitized Sky Survey images will automatically be added
* in addition to the object's normal image links. Also, for some objects, an
@@ -61,7 +61,7 @@ public:
*/
void addLinksToMenu( SkyObject *obj, bool showDSS=true );
- /**@short Create a popup menu for a star.
+ /** @short Create a popup menu for a star.
*
* Stars get the following labels: a primary name and/or a genetive name,
* a spectral type, an object type ("star"), and rise/transit/set times.
@@ -73,7 +73,7 @@ public:
*/
void createStarMenu( StarObject *star );
- /**@short Create a popup menu for a deep-sky object.
+ /** @short Create a popup menu for a deep-sky object.
*
* DSOs get the following labels:
* a common name and/or a catalog name, an object type, and rise/transit/set
@@ -85,7 +85,7 @@ public:
*/
void createDeepSkyObjectMenu( DeepSkyObject *obj );
- /**@short Create a popup menu for a solar system body.
+ /** @short Create a popup menu for a solar system body.
*
* Solar System bodies get a name label, a type label ("solar system object"),
* and rise/set/transit time labels. They also get Center&Track,
@@ -99,7 +99,7 @@ public:
void createMoonMenu( KSMoon *moon );
- /**@short Create a popup menu for a satellite.
+ /** @short Create a popup menu for a satellite.
* @param satellite the satellite which the menu describes.
*/
void createSatelliteMenu( Satellite *satellite );
@@ -110,7 +110,7 @@ public:
*/
void createSupernovaMenu(Supernova *supernova);
- /**@short Create a popup menu for empty sky.
+ /** @short Create a popup menu for empty sky.
*
* The popup menu when right-clicking on nothing is still useful.
* Instead of a name label, it shows "Empty Sky". The rise/set/transit
@@ -127,7 +127,7 @@ private slots:
void slotDeleteFlag( QAction *action );
private:
- /**Initialize the popup menus. Adds name and type labels, and possibly
+ /** Initialize the popup menus. Adds name and type labels, and possibly
* Rise/Set/Transit labels, Center/Track item, and Show Details item.
* @short initialize the right-click popup menu
* @param obj pointer to the skyobject which the menu describes
@@ -144,7 +144,7 @@ private:
void initFlagActions( SkyObject *obj );
- /**Add a submenu for INDI controls (Slew, Track, Sync, etc).
+ /** Add a submenu for INDI controls (Slew, Track, Sync, etc).
* @return true if a valid INDI menu was added.
*/
void addINDI();
diff --git a/kstars/kstars.h b/kstars/kstars.h
index 83c3704..ce7e6fb 100644
--- a/kstars/kstars.h
+++ b/kstars/kstars.h
@@ -393,7 +393,7 @@ public Q_SLOTS:
Q_SCRIPTABLE Q_NOREPLY void openFITS(const QUrl & imageURL);
#endif
- /**@}*/
+ /** @}*/
/**
* Update time-dependent data and (possibly) repaint the sky map.
diff --git a/kstars/kstarsdata.h b/kstars/kstarsdata.h
index 387b002..8794442 100644
--- a/kstars/kstarsdata.h
+++ b/kstars/kstarsdata.h
@@ -54,7 +54,7 @@ class TimeZoneRule;
struct ADVTreeData;
-/**@class KStarsData
+/** @class KStarsData
*KStarsData is the backbone of KStars. It contains all the data used by KStars,
*including the SkyMapComposite that contains all items in the skymap
*(stars, deep-sky objects, planets, constellations, etc). Other kinds of data
@@ -103,10 +103,10 @@ public:
*/
bool isTimeRunningForward() const { return TimeRunsForward; }
- /**@return pointer to the localization (KLocale) object */
+ /** @return pointer to the localization (KLocale) object */
//KLocale *getLocale() { return locale; }
- /**@short Find object by name.
+ /** @short Find object by name.
* @param name Object name to find
* @return pointer to SkyObject matching this name
*/
@@ -138,22 +138,22 @@ public:
/** @return pointer to SkyComposite */
SkyMapComposite* skyComposite() { return m_SkyComposite; }
- /**@return pointer to the ColorScheme object */
+ /** @return pointer to the ColorScheme object */
ColorScheme *colorScheme() { return &CScheme; }
- /**@return pointer to the KSUserDB object */
+ /** @return pointer to the KSUserDB object */
KSUserDB *userdb() { return &m_ksuserdb; }
- /**@return pointer to the Catalog DB object */
+ /** @return pointer to the Catalog DB object */
CatalogDB *catalogdb() { return &m_catalogdb; }
- /**@return pointer to the simulation Clock object */
+ /** @return pointer to the simulation Clock object */
SimClock *clock() { return &Clock; }
- /**@return pointer to the local sidereal time: a dms object */
+ /** @return pointer to the local sidereal time: a dms object */
dms *lst() { return &LST; }
- /**@return pointer to the GeoLocation object*/
+ /** @return pointer to the GeoLocation object*/
GeoLocation *geo() { return &m_Geo; }
/** @return list of all geographic locations */
@@ -236,7 +236,7 @@ signals:
void geoChanged();
public slots:
- /**@short send a message to the console*/
+ /** @short send a message to the console*/
void slotConsoleMessage( QString s ) { std::cout << (const char*)(s.toLocal8Bit()) << std::endl; }
/**Update the Simulation Clock. Update positions of Planets. Update
diff --git a/kstars/kstarsdatetime.h b/kstars/kstarsdatetime.h
index ba6bc9e..d89613c 100644
--- a/kstars/kstarsdatetime.h
+++ b/kstars/kstarsdatetime.h
@@ -26,7 +26,7 @@
class dms;
-/**@class KStarsDateTime
+/** @class KStarsDateTime
*@short Extension of QDateTime for KStars
*KStarsDateTime can represent the date/time as a Julian Day, using a long double,
*in which the fractional portion encodes the time of day to a precision of a less than a second.
diff --git a/kstars/kstarssplash.h b/kstars/kstarssplash.h
index 358202c..f1af7cd 100644
--- a/kstars/kstarssplash.h
+++ b/kstars/kstarssplash.h
@@ -20,7 +20,7 @@
#include <QSplashScreen>
-/**@class KStarsSplash
+/** @class KStarsSplash
* The KStars Splash Screen. The splash screen shows the KStars logo and
* progress messages while data files are parsed and objects are initialized.
* @short the KStars Splash Screen.
@@ -32,7 +32,7 @@ class KStarsSplash : public QSplashScreen
Q_OBJECT
public:
- /**Constructor. Create widgets. Load KStars logo. Start load timer.
+ /** Constructor. Create widgets. Load KStars logo. Start load timer.
* A non-empty customMessage will replace "Welcome to KStars [...]".
*/
explicit KStarsSplash( const QString& customMessage="" );
@@ -41,7 +41,7 @@ public:
~KStarsSplash();
public slots:
- /**Display the text argument in the Splash Screen's status label.
+ /** Display the text argument in the Splash Screen's status label.
* This is connected to KStarsData::progressText(QString)*/
void setMessage(const QString &s);
};
diff --git a/kstars/ksutils.h b/kstars/ksutils.h
index 0df43c9..4352e3e 100644
--- a/kstars/ksutils.h
+++ b/kstars/ksutils.h
@@ -14,7 +14,7 @@
* *
***************************************************************************/
-/**@class KSUtils
+/** @class KSUtils
*@short KStars utility functions
*@author Mark Hollomon
*@version 1.0
diff --git a/kstars/kswizard.h b/kstars/kswizard.h
index dcff389..1ff6ee1 100644
--- a/kstars/kswizard.h
+++ b/kstars/kswizard.h
@@ -45,7 +45,7 @@ public:
explicit WizDownloadUI( QWidget *parent=0 );
};
-/**@class KSWizard
+/** @class KSWizard
* The Setup Wizard will be automatically opened when KStars runs
* for the first time. It allows the user to set up some basic parameters:
* @li Geographic Location
@@ -72,13 +72,13 @@ private slots:
void slotNextPage();
void slotPrevPage();
- /**Set the geo pointer to the user's selected city, and display
+ /** Set the geo pointer to the user's selected city, and display
* its longitude and latitude in the window.
* @note called when the highlighted city in the list box changes
*/
void slotChangeCity();
- /**Display only those cities which meet the user's search criteria
+ /** Display only those cities which meet the user's search criteria
* in the city list box.
* @note called when one of the name filters is modified
*/
@@ -87,12 +87,12 @@ private slots:
void slotDownload();
private:
- /**@short Initialize the geographic location page.
+ /** @short Initialize the geographic location page.
* Populate the city list box, and highlight the current location in the list.
*/
void initGeoPage();
- /**@short set enabled/disable state of Next/Prev buttins based on current page */
+ /** @short set enabled/disable state of Next/Prev buttins based on current page */
void setButtonsEnabled();
QStackedWidget *wizardStack;
diff --git a/kstars/oal/execute.h b/kstars/oal/execute.h
index a1bc4fb..92f0423 100644
--- a/kstars/oal/execute.h
+++ b/kstars/oal/execute.h
@@ -35,17 +35,17 @@ class KStars;
class Execute : public QDialog {
Q_OBJECT
public:
- /**@short Default constructor
+ /** @short Default constructor
*/
Execute();
- /**@short This initializes the combo boxes, and sets up the
+ /** @short This initializes the combo boxes, and sets up the
* dateTime and geolocation from the OL
*/
void init();
public slots:
- /**@short Function to handle the UI when the 'next' button is pressed
+ /** @short Function to handle the UI when the 'next' button is pressed
* This calls the corresponding functions based on the currentIndex
*/
void slotNext();
@@ -53,60 +53,60 @@ Q_OBJECT
/*Function to Save the session details*/
bool saveSession();
- /**@short Function to save the user notes set for
+ /** @short Function to save the user notes set for
* the current object in the target combo box
*/
void addTargetNotes();
- /**@short Function to add the current observation to the observation list
+ /** @short Function to add the current observation to the observation list
*/
bool addObservation();
- /**@short Function to handle the state of current observation,
+ /** @short Function to handle the state of current observation,
* and hiding the execute window
*/
void slotEndSession();
- /**@short Opens the location dialog for setting the current location
+ /** @short Opens the location dialog for setting the current location
*/
void slotLocation();
- /**@short Loads the sessionlist from the OL
+ /** @short Loads the sessionlist from the OL
* into the target combo box
*/
void loadTargets();
- /**@short Sorts the target list using the scheduled time
+ /** @short Sorts the target list using the scheduled time
*/
void sortTargetList();
- /**@short Custom LessThan function for the sort by time
+ /** @short Custom LessThan function for the sort by time
* This compares the times of the two skyobjects
* using an edited QTime as next day 01:00 should
* come later than previous night 23:00
*/
static bool timeLessThan( SkyObject *, SkyObject * );
- /**@short set the currentTarget when the user selection
+ /** @short set the currentTarget when the user selection
* is changed in the target combo box
*/
void slotSetTarget( QString name );
- /**@short loads the equipment list from
+ /** @short loads the equipment list from
* the global logObject into the comboBoxes
*/
void loadEquipment();
- /**@short loads the observer list from
+ /** @short loads the observer list from
* the global logObject into the comboBoxes
*/
void loadObservers();
- /**@short loads the observation edit page
+ /** @short loads the observation edit page
*/
void loadObservationTab();
- /**@short get object name. If star has no name, generate a name based on catalog number.
+ /** @short get object name. If star has no name, generate a name based on catalog number.
* @param translated set to true if the translated name is required.
*/
QString getObjectName(const SkyObject *o, bool translated=true);
diff --git a/kstars/obslistpopupmenu.h b/kstars/obslistpopupmenu.h
index 9cf4d62..d8c3395 100644
--- a/kstars/obslistpopupmenu.h
+++ b/kstars/obslistpopupmenu.h
@@ -32,13 +32,13 @@ class ObsListPopupMenu : public QMenu
{
Q_OBJECT
public:
- /**Default constructor*/
+ /** Default constructor*/
ObsListPopupMenu();
- /**Destructor (empty)*/
+ /** Destructor (empty)*/
virtual ~ObsListPopupMenu();
- /**Initialize the popup menus. */
+ /** Initialize the popup menus. */
/**
* @short initializes the popup menu based on the kind of selection in the observation planner
* @param sessionView true if we are viewing the session, false if we are viewing the wish list
diff --git a/kstars/options/opsadvanced.h b/kstars/options/opsadvanced.h
index 4c3c96f..5ae2d66 100644
--- a/kstars/options/opsadvanced.h
+++ b/kstars/options/opsadvanced.h
@@ -19,7 +19,7 @@
#include "ui_opsadvanced.h"
-/**@class OpsAdvanced
+/** @class OpsAdvanced
*The Advanced Tab of the Options window. In this Tab the user can configure
*advanced behaviors of the program, including:
*@li Whether some objects are hidden when the map is moving (and which objects)
diff --git a/kstars/options/opscolors.h b/kstars/options/opscolors.h
index 6805ad7..924af33 100644
--- a/kstars/options/opscolors.h
+++ b/kstars/options/opscolors.h
@@ -21,7 +21,7 @@
#include "ui_opscolors.h"
-/**@class OpsColors
+/** @class OpsColors
*The Colors page allows the user to adjust all of the colors used to
*display the night sky. The colors are presented as a list of
*colored rectangles and a description of its assignment in the map.
diff --git a/kstars/options/opssatellites.h b/kstars/options/opssatellites.h
index 4819651..e800660 100644
--- a/kstars/options/opssatellites.h
+++ b/kstars/options/opssatellites.h
@@ -34,7 +34,7 @@ public:
bool filterAcceptsRow( int sourceRow, const QModelIndex &sourceParent ) const;
};
-/**@class OpsSatellites
+/** @class OpsSatellites
*The Satellites Tab of the Options window. In this Tab the user can configure
*satellites options and select satellites that should be draw
*@author Jérôme SONRIER
diff --git a/kstars/options/opssolarsystem.h b/kstars/options/opssolarsystem.h
index c9e31f0..fd7b200 100644
--- a/kstars/options/opssolarsystem.h
+++ b/kstars/options/opssolarsystem.h
@@ -21,7 +21,7 @@
class KStars;
-/**@class OpsSolarSystem
+/** @class OpsSolarSystem
*The Solar System page for the Options window. This page allows the user
*to modify display of solar system bodies in KStars, including the
*major planets, the Sun and Moon, and the comets and asteroids.
diff --git a/kstars/options/opssupernovae.h b/kstars/options/opssupernovae.h
index 3ce60c3..e2bcffb 100644
--- a/kstars/options/opssupernovae.h
+++ b/kstars/options/opssupernovae.h
@@ -24,7 +24,7 @@
class KStars;
-/**@class OpsSupernovae
+/** @class OpsSupernovae
*The Supernovae Tab of the Options window. In this Tab the user can configure
*supernovae options and select if supernovae should be drawn on the skymap.
*Also the user is given the option to check for updates on startup. And whether
diff --git a/kstars/projections/projector.h b/kstars/projections/projector.h
index dc32cf6..1e29d4f 100644
--- a/kstars/projections/projector.h
+++ b/kstars/projections/projector.h
@@ -107,7 +107,7 @@ public:
bool oRefract = true,
bool* onVisibleHemisphere = 0) const;
- /**@short Determine RA, Dec coordinates of the pixel at (dx, dy), which are the
+ /** @short Determine RA, Dec coordinates of the pixel at (dx, dy), which are the
* screen pixel coordinate offsets from the center of the Sky pixmap.
* @param the screen pixel position to convert
* @param LST pointer to the local sidereal time, as a dms object.
@@ -130,7 +130,7 @@ public:
bool onScreen( const QPointF& p ) const;
bool onScreen( const Vector2f& p ) const;
- /**@short Determine if the skypoint p is likely to be visible in the display
+ /** @short Determine if the skypoint p is likely to be visible in the display
* window.
*
* checkVisibility() is an optimization function. It determines whether an object
diff --git a/kstars/simclock.h b/kstars/simclock.h
index dfdf048..b7da1df 100644
--- a/kstars/simclock.h
+++ b/kstars/simclock.h
@@ -25,7 +25,7 @@
#include "kstarsdatetime.h"
-/**@class SimClock
+/** @class SimClock
*@short kstars simulation clock
*@author Mark Hollomon
*@version 1.0
@@ -43,10 +43,10 @@ public:
*/
explicit SimClock(QObject *parent = 0, const KStarsDateTime &when = KStarsDateTime::currentDateTime() );
- /**@return const reference to the current simulation Universal Time. */
+ /** @return const reference to the current simulation Universal Time. */
const KStarsDateTime& utc() const { return UTC; }
- /**Whether the clock is active or not is a bit complicated by the
+ /** Whether the clock is active or not is a bit complicated by the
*introduction of "manual mode". In manual mode, SimClock's internal timer
*is stopped, because the clock is ticked manually when the current update
*has finished. So, if ManualMode is true, then isActive() checks
@@ -56,10 +56,10 @@ public:
*/
bool isActive();
- /**@returns the current timestep setting */
+ /** @returns the current timestep setting */
double scale() const { return Scale; }
- /**Manual Mode is a new (04/2002) addition to the SimClock. It is
+ /** Manual Mode is a new (04/2002) addition to the SimClock. It is
*intended to be activated for large timesteps, when we want each frame
*drawn to the screen to be precisely Scale seconds later than the
*previous frame. (i.e., if the timescale is 1 year, then each successive
@@ -87,10 +87,10 @@ public Q_SLOTS:
/** DBUS function to set scale of simclock. */
Q_SCRIPTABLE Q_NOREPLY void setClockScale(float s);
- /**Respond to the QTimer::timeout signal */
+ /** Respond to the QTimer::timeout signal */
void tick();
- /**Equivalent of tick() for manual mode.
+ /** Equivalent of tick() for manual mode.
* If ManualActive is true, add Scale seconds to the SimClock time.
* (we may want to modify this slightly...e.g., the number of seconds in a
* year is not constant (leap years), so it is better to increment the
@@ -98,13 +98,13 @@ public Q_SLOTS:
void manualTick( bool force=false );
signals:
- /**The time has changed (emitted by setUTC() ) */
+ /** The time has changed (emitted by setUTC() ) */
void timeChanged();
- /**The clock has ticked (emitted by tick() )*/
+ /** The clock has ticked (emitted by tick() )*/
void timeAdvanced();
- /**The timestep has changed*/
+ /** The timestep has changed*/
void scaleChanged(float);
/** This is an signal that is called on either clock start or
diff --git a/kstars/skycomponents/asteroidscomponent.h b/kstars/skycomponents/asteroidscomponent.h
index 65a2f8f..4492d05 100644
--- a/kstars/skycomponents/asteroidscomponent.h
+++ b/kstars/skycomponents/asteroidscomponent.h
@@ -25,7 +25,7 @@
class KJob;
-/**@class AsteroidsComponent
+/** @class AsteroidsComponent
* Represents the asteroids on the sky map.
*
* @author Thomas Kabelmann
@@ -34,7 +34,7 @@ class KJob;
class AsteroidsComponent: public SolarSystemListComponent
{
public:
- /**@short Default constructor.
+ /** @short Default constructor.
* @p parent pointer to the parent SolarSystemComposite
*/
explicit AsteroidsComponent(SolarSystemComposite *parent);
diff --git a/kstars/skycomponents/catalogcomponent.h b/kstars/skycomponents/catalogcomponent.h
index 3edc2d6..342f50b 100644
--- a/kstars/skycomponents/catalogcomponent.h
+++ b/kstars/skycomponents/catalogcomponent.h
@@ -82,7 +82,7 @@ private:
/** @short Load data into custom catalog */
void loadData();
- /**@short Read data for existing custom catalogs from disk
+ /** @short Read data for existing custom catalogs from disk
* @return true if catalog data was successfully read
*/
bool readCustomCatalogs();
diff --git a/kstars/skycomponents/cometscomponent.h b/kstars/skycomponents/cometscomponent.h
index 18019bf..3f9c2c1 100644
--- a/kstars/skycomponents/cometscomponent.h
+++ b/kstars/skycomponents/cometscomponent.h
@@ -24,7 +24,7 @@ class SkyLabeler;
#include "datahandlers/ksparser.h"
#include <QList>
-/**@class CometsComponent
+/** @class CometsComponent
* This class encapsulates the Comets
*
* @author Jason Harris
@@ -33,7 +33,7 @@ class SkyLabeler;
class CometsComponent : public SolarSystemListComponent
{
public:
- /**@short Default constructor.
+ /** @short Default constructor.
* @p parent pointer to the parent SolarSystemComposite
*/
explicit CometsComponent(SolarSystemComposite *parent);
diff --git a/kstars/skycomponents/constellationboundarylines.h b/kstars/skycomponents/constellationboundarylines.h
index 6782110..aa56ef8 100644
--- a/kstars/skycomponents/constellationboundarylines.h
+++ b/kstars/skycomponents/constellationboundarylines.h
@@ -41,7 +41,7 @@ typedef QVector<PolyListList*> PolyIndex;
class ConstellationBoundaryLines : public NoPrecessIndex
{
public:
- /**@short Constructor
+ /** @short Constructor
* Simply adds all of the coordinate grid circles
* (meridians and parallels)
* @p parent Pointer to the parent SkyComposite object
@@ -62,7 +62,7 @@ public:
private:
void appendPoly( PolyList* polyList, int debug=0);
- /* @short reads the indices from the KSFileReader instead of using
+ /** @short reads the indices from the KSFileReader instead of using
* the SkyMesh to create them. If the file pointer is null or if
* debug == -1 then we fall back to using the index.
*/
diff --git a/kstars/skycomponents/constellationlines.h b/kstars/skycomponents/constellationlines.h
index d0d1efd..9857720 100644
--- a/kstars/skycomponents/constellationlines.h
+++ b/kstars/skycomponents/constellationlines.h
@@ -25,7 +25,7 @@
class CultureList;
-/*
+/**
*@class ConstellationLines
*Collection of lines making the 88 constellations
@@ -37,7 +37,7 @@ class ConstellationLines : public LineListIndex
{
public:
- /* @short Constructor
+ /** @short Constructor
* @p parent Pointer to the parent SkyComposite object
*
* Constellation lines data is read from clines.dat.
@@ -53,12 +53,12 @@ public:
protected:
const IndexHash& getIndexHash(LineList* lineList );
- /* @short we need to override the update routine because stars are
+ /** @short we need to override the update routine because stars are
* updated differently from mere SkyPoints.
*/
virtual void JITupdate( LineList* lineList );
- /* @short Set the QColor and QPen for drawing. */
+ /** @short Set the QColor and QPen for drawing. */
virtual void preDraw( SkyPainter* skyp );
bool selected();
diff --git a/kstars/skycomponents/constellationnamescomponent.h b/kstars/skycomponents/constellationnamescomponent.h
index b488e52..d3e76ff 100644
--- a/kstars/skycomponents/constellationnamescomponent.h
+++ b/kstars/skycomponents/constellationnamescomponent.h
@@ -34,7 +34,7 @@ class CultureList;
class ConstellationNamesComponent : public ListComponent
{
public:
- /**@short Constructor
+ /** @short Constructor
* @p parent Pointer to the parent SkyComposite object
*
* Reads the constellation names data from cnames.dat
@@ -54,12 +54,12 @@ public:
/** @short Destructor. Delete list members */
virtual ~ConstellationNamesComponent();
- /**@short Draw constellation names on the sky map.
+ /** @short Draw constellation names on the sky map.
* @p psky Reference to the QPainter on which to paint
*/
virtual void draw( SkyPainter *skyp );
- /**@short we need a custom routine (for now) so we don't
+ /** @short we need a custom routine (for now) so we don't
* precess the locations of the names.
*/
virtual void update( KSNumbers *num );
diff --git a/kstars/skycomponents/culturelist.h b/kstars/skycomponents/culturelist.h
index 3613248..a855055 100644
--- a/kstars/skycomponents/culturelist.h
+++ b/kstars/skycomponents/culturelist.h
@@ -20,7 +20,7 @@
#include <QStringList>
-/**@class CultureList
+/** @class CultureList
* A list of all cultures
* FIXME: Why not use a QStringList?
*/
diff --git a/kstars/skycomponents/deepskycomponent.h b/kstars/skycomponents/deepskycomponent.h
index e2594ef..2c68e1d 100644
--- a/kstars/skycomponents/deepskycomponent.h
+++ b/kstars/skycomponents/deepskycomponent.h
@@ -62,7 +62,7 @@ public:
virtual void draw( SkyPainter *skyp );
- /* @short draw all the labels in the prioritized LabelLists and then
+ /** @short draw all the labels in the prioritized LabelLists and then
* clear the LabelLists.
*/
void drawLabels();
diff --git a/kstars/skycomponents/ecliptic.h b/kstars/skycomponents/ecliptic.h
index 0163841..29d31ff 100644
--- a/kstars/skycomponents/ecliptic.h
+++ b/kstars/skycomponents/ecliptic.h
@@ -32,7 +32,7 @@ class Ecliptic : public LineListIndex
{
public:
- /* @short Constructor
+ /** @short Constructor
* @p parent pointer to the parent SkyComposite object
* name is the name of the subclass
*/
diff --git a/kstars/skycomponents/equator.h b/kstars/skycomponents/equator.h
index 0647d7a..ae22a58 100644
--- a/kstars/skycomponents/equator.h
+++ b/kstars/skycomponents/equator.h
@@ -33,7 +33,7 @@ class Equator : public NoPrecessIndex
{
public:
- /* @short Constructor
+ /** @short Constructor
* @p parent pointer to the parent SkyComposite object
* name is the name of the subclass
*/
diff --git a/kstars/skycomponents/flagcomponent.h b/kstars/skycomponents/flagcomponent.h
index 811f3f5..ca59131 100644
--- a/kstars/skycomponents/flagcomponent.h
+++ b/kstars/skycomponents/flagcomponent.h
@@ -27,7 +27,7 @@
#include "skymesh.h"
-/**@class FlagComponent
+/** @class FlagComponent
* @short Represents a flag on the sky map.
* Each flag is composed by a SkyPoint where coordinates are stored, an
* epoch and a label. This class also stores flag images and associates
@@ -55,7 +55,7 @@ public:
virtual bool selected();
- /**@short Add a flag.
+ /** @short Add a flag.
* @param SkyPoint Reference to the SkyPoint used to store coordinates
* @param epoch Moment for which celestial coordinates are specified
* @param image Image name
@@ -63,12 +63,12 @@ public:
*/
void add( SkyPoint* flagPoint, QString epoch, QString image, QString label, QColor labelColor );
- /**@short Remove a flag.
+ /** @short Remove a flag.
* @param index Index of the flag to be remove.
*/
void remove( int index );
- /**@short Update a flag.
+ /** @short Update a flag.
*@param index index of the flag to be updated.
*@param flagPoint new flag point.
*@param epoch new flag epoch.
@@ -78,67 +78,67 @@ public:
*/
void updateFlag ( int index, SkyPoint* flagPoint, QString epoch, QString image, QString label, QColor labelColor );
- /**@short Return image names.
+ /** @short Return image names.
* @return the list of all image names
*/
QStringList getNames();
- /**@short Return the numbers of flags.
+ /** @short Return the numbers of flags.
* @return the size of m_PointList
*/
int size();
- /**@short Get epoch.
+ /** @short Get epoch.
* @return the epoch as a string
* @param index Index of the flag
*/
QString epoch( int index );
- /**@short Get label.
+ /** @short Get label.
* @return the label as a string
* @param index Index of the flag
*/
QString label( int index );
- /**@short Get label color.
+ /** @short Get label color.
* @return the label color
* @param index Index of the flag
*/
QColor labelColor( int index );
- /**@short Get image.
+ /** @short Get image.
* @return the image associated with the flag
* @param index Index of the flag
*/
QImage image( int index );
- /**@short Get image name.
+ /** @short Get image name.
* @return the name of the image associated with the flag
* @param index Index of the flag
*/
QString imageName( int index );
- /**@short Get images.
+ /** @short Get images.
* @return all images that can be use
*/
QList<QImage> imageList();
- /**@short Get image.
+ /** @short Get image.
* @param index Index of the image in m_Images
* @return an image from m_Images
*/
QImage imageList( int index );
- /**@short Get list of flag indexes near specified SkyPoint with radius specified in pixels.
+ /** @short Get list of flag indexes near specified SkyPoint with radius specified in pixels.
*@param point central SkyPoint.
*@param pixelRadius radius in pixels.
*/
QList<int> getFlagsNearPix( SkyPoint *point, int pixelRadius );
- /**@short Load flags from flags.dat file. */
+ /** @short Load flags from flags.dat file. */
void loadFromFile();
- /**@short Save flags to flags.dat file. */
+ /** @short Save flags to flags.dat file. */
void saveToFile();
private:
diff --git a/kstars/skycomponents/highpmstarlist.h b/kstars/skycomponents/highpmstarlist.h
index 2780db3..f040a1b 100644
--- a/kstars/skycomponents/highpmstarlist.h
+++ b/kstars/skycomponents/highpmstarlist.h
@@ -24,7 +24,7 @@
class SkyMesh;
struct HighPMStar;
-/* @class HighPMStarList
+/** @class HighPMStarList
* Holds a list of stars with high proper motion along with the trixel each star
* is currently located in. The purpose of this class is to save some time by
* only re-indexing the stars with high proper motion instead of the entire
@@ -40,40 +40,40 @@ struct HighPMStar;
class HighPMStarList
{
public:
- /* @short Constructor
+ /** @short Constructor
*/
explicit HighPMStarList( double threshold );
~HighPMStarList();
- /* @short adds the star located at trixel to the list if the pm is
+ /** @short adds the star located at trixel to the list if the pm is
* greater than the threshold. We also use the pm to determine the
* update interval. Returns true if the star was appended and false
* otherwise.
*/
bool append( Trixel trixel, StarObject* star, double pm );
- /* @short returns the threshold.
+ /** @short returns the threshold.
*/
double threshold() const { return m_threshold; }
- /* @short returns the number of stars in the list.
+ /** @short returns the number of stars in the list.
*/
int size() const { return m_stars.size(); }
- /* @short sets the time this list was last indexed to. Normally this
+ /** @short sets the time this list was last indexed to. Normally this
* is done automatically in the reindex() routine but this is useful
* if the entire starIndex gets re-indexed.
*/
void setIndexTime( KSNumbers *num );
- /* @short if the date in num differs from the last time we indexed by
+ /** @short if the date in num differs from the last time we indexed by
* more than our update interval then we re-index all the stars in our
* list that have actually changed trixels.
*/
void reindex( KSNumbers *num, StarIndex* starIndex );
- /* @short prints out some brief statistics.
+ /** @short prints out some brief statistics.
*/
void stats();
diff --git a/kstars/skycomponents/linelistindex.h b/kstars/skycomponents/linelistindex.h
index 3317db3..7d92e8b 100644
--- a/kstars/skycomponents/linelistindex.h
+++ b/kstars/skycomponents/linelistindex.h
@@ -30,7 +30,7 @@ class SkyPainter;
class LineList;
class SkipList;
-/* @class LineListIndex
+/** @class LineListIndex
* Contains almost all the code needed for indexing and drawing and clipping
* lines and polygons.
*
@@ -39,7 +39,7 @@ class SkipList;
class LineListIndex : public SkyComponent
{
public:
- /* @short Constructor
+ /** @short Constructor
* Simply set the internal skyMesh, parent, and name.
* @param parent Pointer to the parent SkyComponent object
* @param mesh Pointer to the universal SkyMesh instance
@@ -47,10 +47,10 @@ public:
*/
explicit LineListIndex( SkyComposite *parent, const QString& name="" );
- /* @short Destructor */
+ /** @short Destructor */
~LineListIndex();
- /* @short. The top level draw routine. Draws all the LineLists for any
+ /** @short. The top level draw routine. Draws all the LineLists for any
* subclass in one fell swoop which minimizes some of the loop overhead.
* Overridden by MilkWay so it can decide whether to draw outlines or
* filled. Therefore MilkyWay does not need to override preDraw(). The
@@ -60,7 +60,7 @@ public:
virtual void draw( SkyPainter *skyp );
protected:
- /* @short this is called from within the draw routines when the updateID
+ /** @short this is called from within the draw routines when the updateID
* of the lineList is stale. It is virtual because different subclasses
* have different update routines. NoPrecessIndex doesn't precess in
* the updates and ConstellationLines must update its points as stars,
@@ -68,7 +68,7 @@ protected:
*/
virtual void JITupdate( LineList* lineList );
- /* @short as the name says, recreates the lineIndex using the LineLists
+ /** @short as the name says, recreates the lineIndex using the LineLists
* in the previous index. Since we are indexing everything at J2000
* this is only used by ConstellationLines which needs to reindex
* because of the proper motion of the stars.
@@ -78,20 +78,20 @@ protected:
/** @short retrieve name of object */
QString name() const { return m_name; }
- /* @short displays a message that we are loading m_name. Also prints
+ /** @short displays a message that we are loading m_name. Also prints
* out the message if skyMesh debug is greater than zero.
*/
void intro();
- /* @short prints out some summary statistics if the skyMesh debug is
+ /** @short prints out some summary statistics if the skyMesh debug is
* greater than 1.
*/
void summary();
- /* @short Returns the SkyMesh object. */
+ /** @short Returns the SkyMesh object. */
SkyMesh* skyMesh() { return m_skyMesh; }
- /* @short Typically called from within a subclasses constructors.
+ /** @short Typically called from within a subclasses constructors.
* Adds the trixels covering the outline of lineList to the lineIndex.
*
* @param debug if greater than zero causes the number of trixels found
@@ -99,7 +99,7 @@ protected:
*/
void appendLine( LineList* lineList, int debug=0 );
- /* @short Typically called from within a subclasses constructors.
+ /** @short Typically called from within a subclasses constructors.
* Adds the trixels covering the full lineList to the polyIndex.
*
* @param debug if greater than zero causes the number of trixels found
@@ -107,33 +107,33 @@ protected:
*/
void appendPoly( LineList* lineList, int debug=0 );
- /* @short a convenience method that adds a lineList to both the lineIndex
+ /** @short a convenience method that adds a lineList to both the lineIndex
* and the polyIndex.
*/
void appendBoth( LineList* lineList, int debug=0 );
- /* @short Draws all the lines in m_listList as simple lines in float
+ /** @short Draws all the lines in m_listList as simple lines in float
* mode.
*/
void drawLines( SkyPainter* skyp );
- /* @short Draws all the lines in m_listList as filled polygons in float
+ /** @short Draws all the lines in m_listList as filled polygons in float
* mode.
*/
void drawFilled( SkyPainter* skyp );
- /* @short Gives the subclasses access to the top of the draw() method.
+ /** @short Gives the subclasses access to the top of the draw() method.
* Typically used for setting the QPen, etc. in the QPainter being
* passed in. Defaults to setting a thin white pen.
*/
virtual void preDraw( SkyPainter* skyp );
- /* @short a callback overridden by NoPrecessIndex so it can use the
+ /** @short a callback overridden by NoPrecessIndex so it can use the
* drawing code with the non-reverse-precessed mesh buffer.
*/
virtual MeshBufNum_t drawBuffer() { return DRAW_BUF; }
- /* @short Returns an IndexHash from the SkyMesh that contains the set of
+ /** @short Returns an IndexHash from the SkyMesh that contains the set of
* trixels that cover lineList. Overridden by SkipListIndex so it can
* pass SkyMesh an IndexHash indicating which line segments should not
* be indexed @param lineList contains the list of points to be covered.
@@ -148,7 +148,7 @@ protected:
*/
virtual SkipList* skipList( LineList* lineList );
- virtual LineListLabel* label() {return 0;};
+ virtual LineListLabel* label() {return 0;}
inline LineListList listList() const { return m_listList; }
diff --git a/kstars/skycomponents/linelistlabel.h b/kstars/skycomponents/linelistlabel.h
index a46cf3b..d47d07d 100644
--- a/kstars/skycomponents/linelistlabel.h
+++ b/kstars/skycomponents/linelistlabel.h
@@ -41,11 +41,11 @@ public:
enum { TopCandidate, BotCandidate, LeftCandidate, RightCandidate };
- /* @short prepare the context for selecting label position candidates.
+ /** @short prepare the context for selecting label position candidates.
*/
void reset();
- /* @short draw the label if any. Is currently called at the bottom of
+ /** @short draw the label if any. Is currently called at the bottom of
* draw() but that call could be removed and it could be called
* externally AFTER draw() has been called so draw() can set up the label
* position candidates.
@@ -65,7 +65,7 @@ private:
float m_marginLeft, m_marginRight, m_marginTop, m_marginBot;
float m_farLeft, m_farRight, m_farTop, m_farBot;
- /* @short This routine does two things at once. It returns the QPointF
+ /** @short This routine does two things at once. It returns the QPointF
* corresponding to pointList[i] and also computes the angle using
* pointList[i] and pointList[i-1] therefore you MUST ensure that:
*
diff --git a/kstars/skycomponents/listcomponent.h b/kstars/skycomponents/listcomponent.h
index 0b1982f..18ef873 100644
--- a/kstars/skycomponents/listcomponent.h
+++ b/kstars/skycomponents/listcomponent.h
@@ -40,7 +40,7 @@ public:
virtual ~ListComponent();
- /**@short Update the sky positions of this component.
+ /** @short Update the sky positions of this component.
*
* This function usually just updates the Horizontal (Azimuth/Altitude)
* coordinates of the objects in this component. If the KSNumbers*
diff --git a/kstars/skycomponents/milkyway.h b/kstars/skycomponents/milkyway.h
index a8d88fb..2ebd2c9 100644
--- a/kstars/skycomponents/milkyway.h
+++ b/kstars/skycomponents/milkyway.h
@@ -35,7 +35,7 @@
class MilkyWay : public LineListIndex
{
public:
- /**@short Constructor
+ /** @short Constructor
* @p parent pointer to the parent SkyComposite
*/
explicit MilkyWay( SkyComposite *parent );
@@ -46,20 +46,20 @@ public:
virtual void draw( SkyPainter *skyp );
virtual bool selected();
-protected:
- // FIXME: Implementation is broken!!
- /**@short Returns an IndexHash from the SkyMesh that contains the set
+protected:
+ /** @short Returns an IndexHash from the SkyMesh that contains the set
* of trixels that cover the _SkipList_ lineList excluding skipped
* lines as specified in the SkipList. SkipList is a subclass of
* LineList.
+ * FIXME: Implementation is broken!!
*/
const IndexHash& getIndexHash( LineList* skipList );
- // FIXME: Implementation is broken!!
- /**@short Returns a boolean indicating whether to skip the i-th line
+ /** @short Returns a boolean indicating whether to skip the i-th line
* segment in the _SkipList_ skipList. Note that SkipList is a
* subclass of LineList. This routine allows us to use the drawing
* code in LineListIndex instead of repeating it all here.
+ * FIXME: Implementation is broken!!
*/
virtual SkipList* skipList(LineList* lineList);
diff --git a/kstars/skycomponents/noprecessindex.h b/kstars/skycomponents/noprecessindex.h
index ad32659..e706230 100644
--- a/kstars/skycomponents/noprecessindex.h
+++ b/kstars/skycomponents/noprecessindex.h
@@ -20,7 +20,7 @@
#include "linelistindex.h"
-/**@class NoPrecessIndex
+/** @class NoPrecessIndex
*
* @author James B. Bowlin
* @version 0.1
@@ -28,16 +28,16 @@
class NoPrecessIndex : public LineListIndex
{
public:
- /* @short Constructor */
+ /** @short Constructor */
NoPrecessIndex( SkyComposite *parent, const QString& name );
protected:
- /* @ short override JITupdate so we don't perform the precession
+ /** @ short override JITupdate so we don't perform the precession
* correction, only rotation.
*/
virtual void JITupdate( LineList* lineList );
- /* @short we need to use the buffer that does not have the
+ /** @short we need to use the buffer that does not have the
* reverse-precession correction.
*/
virtual MeshBufNum_t drawBuffer() { return NO_PRECESS_BUF; }
diff --git a/kstars/skycomponents/planetmoonscomponent.h b/kstars/skycomponents/planetmoonscomponent.h
index a394c95..51d785f 100644
--- a/kstars/skycomponents/planetmoonscomponent.h
+++ b/kstars/skycomponents/planetmoonscomponent.h
@@ -59,7 +59,7 @@ public:
SkyObject* objectNearest( SkyPoint *p, double &maxrad );
- /**@return a pointer to a moon if its name matches the argument
+ /** @return a pointer to a moon if its name matches the argument
*
* @p name the name to be matched
* @return a SkyObject pointer to the moon whose name matches
diff --git a/kstars/skycomponents/pointlistcomponent.h b/kstars/skycomponents/pointlistcomponent.h
index 11c685c..345364e 100644
--- a/kstars/skycomponents/pointlistcomponent.h
+++ b/kstars/skycomponents/pointlistcomponent.h
@@ -42,7 +42,7 @@ public:
virtual ~PointListComponent();
- /**@short Update the sky positions of this component.
+ /** @short Update the sky positions of this component.
*
* This function usually just updates the Horizontal (Azimuth/Altitude)
* coordinates of the objects in this component. However, the precession
diff --git a/kstars/skycomponents/skycomponent.h b/kstars/skycomponents/skycomponent.h
index 31ce51e..9e425fa 100644
--- a/kstars/skycomponents/skycomponent.h
+++ b/kstars/skycomponents/skycomponent.h
@@ -124,7 +124,7 @@ class SkyPainter;
class SkyComponent
{
public:
- /**@short Constructor
+ /** @short Constructor
* @p parent pointer to the parent SkyComposite
*/
explicit SkyComponent( SkyComposite *parent );
@@ -132,12 +132,12 @@ public:
/** @short Destructor */
virtual ~SkyComponent();
- /**@short Draw the object on the SkyMap
+ /** @short Draw the object on the SkyMap
* @p skyp a pointer to the SkyPainter to use
*/
virtual void draw( SkyPainter *skyp ) = 0;
- /**@short Draw trails for objects. */
+ /** @short Draw trails for objects. */
virtual void drawTrails( SkyPainter *skyp );
/**
@@ -155,10 +155,10 @@ public:
virtual void updatePlanets( KSNumbers * ) {}
virtual void updateMoons( KSNumbers * ) {}
- /**@return true if component is to be drawn on the map. */
+ /** @return true if component is to be drawn on the map. */
virtual bool selected() { return true; }
- /**@return Parent of component. If there is no parent returns NULL. */
+ /** @return Parent of component. If there is no parent returns NULL. */
SkyComposite* parent() { return m_parent; }
/**
@@ -198,7 +198,7 @@ public:
*/
virtual SkyObject* objectNearest( SkyPoint *p, double &maxrad );
- /**@short Emit signal about progress.
+ /** @short Emit signal about progress.
*
* @sa SkyMapComposite::emitProgressText
*/
diff --git a/kstars/skycomponents/skycomposite.h b/kstars/skycomponents/skycomposite.h
index 345d724..61393f6 100644
--- a/kstars/skycomponents/skycomposite.h
+++ b/kstars/skycomponents/skycomposite.h
@@ -43,7 +43,7 @@ class KSNumbers;
class SkyComposite : public SkyComponent
{
public:
- /**@short Constructor
+ /** @short Constructor
* @p parent pointer to the parent SkyComponent
*/
explicit SkyComposite( SkyComposite *parent );
@@ -51,12 +51,12 @@ public:
/** *@short Destructor */
virtual ~SkyComposite();
- /**@short Delegate draw requests to all sub components
+ /** @short Delegate draw requests to all sub components
* @p psky Reference to the QPainter on which to paint
*/
virtual void draw( SkyPainter *skyp );
- /**@short Delegate update-position requests to all sub components
+ /** @short Delegate update-position requests to all sub components
*
* This function usually just updates the Horizontal (Azimuth/Altitude)
* coordinates. However, the precession and nutation must also be
@@ -71,17 +71,17 @@ public:
*/
virtual void update( KSNumbers *num=0 );
- /**@short Add a new sub component to the composite
+ /** @short Add a new sub component to the composite
* @p comp Pointer to the SkyComponent to be added
*/
void addComponent(SkyComponent *comp);
- /**@short Remove a sub component from the composite
+ /** @short Remove a sub component from the composite
* @p comp Pointer to the SkyComponent to be removed.
*/
void removeComponent(SkyComponent *comp);
- /**@short Search the children of this SkyComposite for
+ /** @short Search the children of this SkyComposite for
* a SkyObject whose name matches the argument.
*
* The objects' primary, secondary and long-form names will
@@ -92,7 +92,7 @@ public:
*/
virtual SkyObject* findByName( const QString &name );
- /**@short Identify the nearest SkyObject to the given SkyPoint,
+ /** @short Identify the nearest SkyObject to the given SkyPoint,
* among the children of this SkyComposite
* @p p pointer to the SkyPoint around which to search.
* @p maxrad reference to current search radius
diff --git a/kstars/skycomponents/skymapcomposite.h b/kstars/skycomponents/skymapcomposite.h
index c410fa6..31894b7 100644
--- a/kstars/skycomponents/skymapcomposite.h
+++ b/kstars/skycomponents/skymapcomposite.h
@@ -53,7 +53,7 @@ class DeepSkyObject;
class KSPlanetBase;
class KSPlanet;
-/**@class SkyMapComposite
+/** @class SkyMapComposite
*SkyMapComposite is the root object in the object hierarchy of the sky map.
*All requests to update, init, draw etc. will be done with this class.
*The requests will be delegated to it's children.
diff --git a/kstars/skycomponents/skymesh.h b/kstars/skycomponents/skymesh.h
index 6783abd..f940415 100644
--- a/kstars/skycomponents/skymesh.h
+++ b/kstars/skycomponents/skymesh.h
@@ -56,7 +56,7 @@ enum MeshBufNum_t {
NUM_MESH_BUF
};
-/*@class SkyMesh
+/** @class SkyMesh
* Provides an interface to the Hierarchical Triangular Mesh (HTM) library
* written by A. Szalay, John Doug Reynolds, Jim Gray, and Peter Z. Kunszt.
*
@@ -99,7 +99,7 @@ protected:
SkyMesh( SkyMesh& skyMesh );
public:
- /* @short creates the single instance of SkyMesh. The level indicates
+ /** @short creates the single instance of SkyMesh. The level indicates
* how fine a mesh we will use. The number of triangles (trixels) in the
* mesh will be 8 * 4^level so a mesh of level 5 will have 8 * 4^5 = 8 *
* 2^10 = 8192 trixels. The size of the triangles are roughly pi / *
@@ -108,7 +108,7 @@ public:
*/
static SkyMesh* Create( int level );
- /* @short returns the default instance of SkyMesh or null if it has not
+ /** @short returns the default instance of SkyMesh or null if it has not
* yet been created.
*/
static SkyMesh* Instance();
@@ -135,7 +135,7 @@ public:
*/
void aperture( SkyPoint *center, double radius, MeshBufNum_t bufNum=DRAW_BUF );
- /* @short returns the index of the trixel containing p.
+ /** @short returns the index of the trixel containing p.
*/
Trixel index( const SkyPoint *p );
@@ -147,88 +147,98 @@ public:
*/
const SkyRegion& skyRegion( const SkyPoint& p1, const SkyPoint& p2 );
- //----- Stars and CLines -----
+ /** @name Stars and CLines
+ Routines used for indexing stars and CLines.
+ The following four routines are used for indexing stars and CLines.
+ They differ from the normal routines because they take proper motion
+ into account while the normal routines always index the J2000
+ position.
- // The follow four routines are used for indexing stars and CLines.
- // They differ from the normal routines because they take proper motion
- // into account while the normal routines always index the J2000
- // position.
- //
- // Since the proper motion depends on time, it is essential to call
- // setKSNumbers to set the time before doing the indexing. The default
- // value is J2000.
+ Since the proper motion depends on time, it is essential to call
+ setKSNumbers to set the time before doing the indexing. The default
+ value is J2000.
+ */
- /* @short sets the time for indexing StarObjects and CLines.
+ /** @{*/
+
+ /** @short sets the time for indexing StarObjects and CLines.
*/
void setKSNumbers( KSNumbers* num ) { m_KSNumbers = KSNumbers( *num ); }
- /* @short returns the trixel that contains the star at the set
+ /** @short returns the trixel that contains the star at the set
* time with proper motion taken into account but not precession.
* This is a feature not a bug.
*/
Trixel indexStar( StarObject *star );
- /* @short fills the default buffer with all the trixels needed to cover
+ /** @short fills the default buffer with all the trixels needed to cover
* the line connecting the two stars.
*/
void indexStar( StarObject* star1, StarObject* star2 );
- /* @short Fills a hash with all the trixels needed to cover all the line
+ /** @short Fills a hash with all the trixels needed to cover all the line
* segments in the SkyList where each SkyPoint is assumed to be a star
* and proper motion is taken into account. Used only by
* ConstellationsLines.
*/
const IndexHash& indexStarLine( SkyList* points );
+ /** @}*/
//----- Here come index routines for various shapes -----
- //--- First the QPointF routines ---
+ /** @name Multi Shape Index Routines
+ * The first two routines use QPoint and the rest use SkyPoint
+ */
+
+ /** @{*/
- /* @short finds the indices of the trixels that cover the triangle
+ /** @short finds the indices of the trixels that cover the triangle
* specified by the three QPointF's.
*/
void index( const QPointF &p1, const QPointF &p2, const QPointF &p3 );
- /* @short Finds the trixels needed to cover the quadrilateral specified
+ /** @short Finds the trixels needed to cover the quadrilateral specified
* by the four QPointF's.
*/
void index( const QPointF &p1, const QPointF &p2, const QPointF &p3,
const QPointF &p4 );
- //--- Now the SkyPoint Routines ---
-
- /* @short finds the indices of the trixels covering the circle specified
+ /** @short finds the indices of the trixels covering the circle specified
* by center and radius.
*/
void index( const SkyPoint *center, double radius, MeshBufNum_t bufNum=DRAW_BUF );
- /* @short finds the indices of the trixels covering the line segment
+ /** @short finds the indices of the trixels covering the line segment
* connecting p1 and p2.
*/
void index( const SkyPoint* p1, const SkyPoint* p2 );
- /* @short finds the indices of the trixels covering the triangle
+ /** @short finds the indices of the trixels covering the triangle
* specified by vertices: p1, p2, and p3.
*/
void index( const SkyPoint* p1, const SkyPoint* p2, const SkyPoint* p3 );
- /* @short finds the indices of the trixels covering the quadralateral
+ /** @short finds the indices of the trixels covering the quadralateral
* specified by the vertices: p1, p2, p3, and p4.
*/
void index( const SkyPoint* p1, const SkyPoint* p2, const SkyPoint* p3, const SkyPoint* p4 );
+ /** @}*/
- //----- IndexHash Routines -----
+ /** @name IndexHash Routines
- // The follow routines are used to index SkyList data structures. They
- // fill a QHash with the indices of the trixels that cover the data
- // structure. These are all used as callbacks in the LineListIndex
- // subclasses so they can use the same indexing code to index differnt
- // data structures. See also indexStarLine() above.
+ The follow routines are used to index SkyList data structures. They
+ fill a QHash with the indices of the trixels that cover the data
+ structure. These are all used as callbacks in the LineListIndex
+ subclasses so they can use the same indexing code to index differnt
+ data structures. See also indexStarLine() above.
+ */
- /* @short fills a QHash with the trixel indices needed to cover all the
+ /** @{*/
+
+ /** @short fills a QHash with the trixel indices needed to cover all the
* line segments specified in the QVector<SkyPoints*> points.
*
* @param points the points of the line segment. @debug causes extra
@@ -236,7 +246,7 @@ public:
*/
const IndexHash& indexLine( SkyList* points );
- /* @short as above but allows for skipping the indexing of some of
+ /** @short as above but allows for skipping the indexing of some of
* the points.
*
* @param points the line segment to be indexed.
@@ -247,7 +257,7 @@ public:
*/
const IndexHash& indexLine( SkyList* points, IndexHash* skip );
- /* @short fills a QHash with the trixel indices needed to cover the
+ /** @short fills a QHash with the trixel indices needed to cover the
* polygon specified in the QList<SkyPoints*> points. There is no
* version with a skip parameter because it does not make sense to
* skip some of the edges of a filled polygon.
@@ -257,33 +267,35 @@ public:
*/
const IndexHash& indexPoly( SkyList* points );
- /* @short does the same as above but with a QPolygonF as the
+ /** @short does the same as above but with a QPolygonF as the
* container for the points.
*/
const IndexHash& indexPoly( const QPolygonF* points );
- /* @short Returns the debug level. This is used as a global debug level
+ /** @}*/
+
+ /** @short Returns the debug level. This is used as a global debug level
* for LineListIndex and its subclasses.
*/
int debug() const { return m_debug; }
- /* @short Sets the debug level.
+ /** @short Sets the debug level.
*/
void debug( int debug ) { m_debug = debug; }
- /* @return the current drawID which gets incremented each time aperture()
+ /** @return the current drawID which gets incremented each time aperture()
* is called.
*/
DrawID drawID( ) const { return m_drawID; }
- /* @short increments the drawID and returns the new value. This is
+ /** @short increments the drawID and returns the new value. This is
* useful when you want to use the drawID to ensure you are not
* repeating yourself when iterating over the elements of an IndexHash.
* It is currently used in LineListIndex::reindex().
*/
int incDrawID() { return ++m_drawID; }
- /* @short Draws the outline of all the trixels in the specified buffer.
+ /** @short Draws the outline of all the trixels in the specified buffer.
* This was very useful during debugging. I don't precess the points
* because I mainly use it with the IN_CONSTELL_BUF which is not
* precessed. We will probably have buffers serve double and triple
diff --git a/kstars/skycomponents/solarsystemcomposite.h b/kstars/skycomponents/solarsystemcomposite.h
index b84d706..28ea5f8 100644
--- a/kstars/skycomponents/solarsystemcomposite.h
+++ b/kstars/skycomponents/solarsystemcomposite.h
@@ -29,7 +29,7 @@ class AsteroidsComponent;
class CometsComponent;
class SkyLabeler;
-/**@class SolarSystemComposite
+/** @class SolarSystemComposite
* The solar system composite manages all planets, asteroids and comets.
* As every sub component of solar system needs the earth , the composite
* is managing this object by itself.
diff --git a/kstars/skycomponents/solarsystemlistcomponent.h b/kstars/skycomponents/solarsystemlistcomponent.h
index c702034..22373a5 100644
--- a/kstars/skycomponents/solarsystemlistcomponent.h
+++ b/kstars/skycomponents/solarsystemlistcomponent.h
@@ -38,7 +38,7 @@ public:
virtual void update( KSNumbers *num );
- /**@short Update the coordinates of the solar system bodies in this component.
+ /** @short Update the coordinates of the solar system bodies in this component.
*
* This function updates the position of the moving solar system bodies.
* @p data Pointer to the KStarsData object
diff --git a/kstars/skycomponents/starblocklist.cpp b/kstars/skycomponents/starblocklist.cpp
index 044f862..7560bf1 100644
--- a/kstars/skycomponents/starblocklist.cpp
+++ b/kstars/skycomponents/starblocklist.cpp
@@ -89,7 +89,7 @@ bool StarBlockList::fillToMag( float maglim ) {
if( readOffset <= 0 )
readOffset = dSReader->getOffset( trixelId );
- Q_ASSERT( nBlocks == blocks.size() );
+ Q_ASSERT( nBlocks == (unsigned int) blocks.size() );
BinFileHelper::unsigned_KDE_fseek( dataFile, readOffset, SEEK_SET );
diff --git a/kstars/skycomponents/starcomponent.h b/kstars/skycomponents/starcomponent.h
index df86689..ebe7fb6 100644
--- a/kstars/skycomponents/starcomponent.h
+++ b/kstars/skycomponents/starcomponent.h
@@ -67,10 +67,10 @@ public:
virtual ~StarComponent();
// TODO: Desingletonize StarComponent
- /**@short Create an instance of StarComponent */
+ /** @short Create an instance of StarComponent */
static StarComponent *Create( SkyComposite* );
- /**@return the instance of StarComponent if already created, NULL otherwise */
+ /** @return the instance of StarComponent if already created, NULL otherwise */
static StarComponent *Instance() { return pinstance; }
//This function is empty; we need that so that the JiT update
@@ -81,7 +81,7 @@ public:
void draw( SkyPainter *skyp );
- /* @short draw all the labels in the prioritized LabelLists and then
+ /** @short draw all the labels in the prioritized LabelLists and then
* clear the LabelLists. */
void drawLabels();
@@ -145,7 +145,7 @@ public:
static void byteSwap( starData *stardata );
private:
- /**@short Read data for stars which will remain static in the memory
+ /** @short Read data for stars which will remain static in the memory
*
* This method reads data for named stars (stars having names,
* which are stored by default in "namedstars.dat") into
diff --git a/kstars/skymap.h b/kstars/skymap.h
index 86d7965..4d39e0d 100644
--- a/kstars/skymap.h
+++ b/kstars/skymap.h
@@ -54,7 +54,7 @@ class SkyMapGLDraw;
class SkyMapQDraw;
#endif
-/**@class SkyMap
+/** @class SkyMap
*
*This is the canvas on which the sky is painted. It's the main widget for KStars.
*Contains SkyPoint members for the map's Focus (current central position), Destination
@@ -101,25 +101,25 @@ class SkyMap : public QGraphicsView {
Gnomonic,
UnknownProjection };
- /**@return the angular field of view of the sky map, in degrees.
+ /** @return the angular field of view of the sky map, in degrees.
*@note it must use either the height or the width of the window to calculate the
*FOV angle. It chooses whichever is larger.
*/
float fov();
- /**@short Update object name and coordinates in the Focus InfoBox */
+ /** @short Update object name and coordinates in the Focus InfoBox */
void showFocusCoords();
- /**@short Update the focus position according to current options. */
+ /** @short Update the focus position according to current options. */
void updateFocus();
- /**@short Retrieve the Focus point; the position on the sky at the
+ /** @short Retrieve the Focus point; the position on the sky at the
*center of the skymap.
*@return a pointer to the central focus point of the sky map
*/
SkyPoint* focus() { return &Focus; }
- /**@short retrieve the Destination position.
+ /** @short retrieve the Destination position.
*
*The Destination is the point on the sky to which the focus will
*be moved.
@@ -128,7 +128,7 @@ class SkyMap : public QGraphicsView {
*/
SkyPoint* destination() { return &Destination; }
- /**@short retrieve the FocusPoint position.
+ /** @short retrieve the FocusPoint position.
*
*The FocusPoint stores the position on the sky that is to be
*focused next. This is not exactly the same as the Destination
@@ -139,12 +139,12 @@ class SkyMap : public QGraphicsView {
*/
SkyPoint* focusPoint() { return &FocusPoint; }
- /**@short sets the central focus point of the sky map.
+ /** @short sets the central focus point of the sky map.
*@param f a pointer to the SkyPoint the map should be centered on
*/
void setFocus( SkyPoint *f );
- /**@short sets the focus point of the skymap, using ra/dec coordinates
+ /** @short sets the focus point of the skymap, using ra/dec coordinates
*
*@note This function behaves essentially like the above function.
*It differs only in the data types of its arguments.
@@ -154,13 +154,13 @@ class SkyMap : public QGraphicsView {
*/
void setFocus( const dms &ra, const dms &dec );
- /**@short sets the focus point of the sky map, using its alt/az coordinates
+ /** @short sets the focus point of the sky map, using its alt/az coordinates
*@param alt the new altitude
*@param az the new azimuth
*/
void setFocusAltAz( const dms &alt, const dms & az);
- /**@short sets the destination point of the sky map.
+ /** @short sets the destination point of the sky map.
*@note setDestination() emits the destinationChanged() SIGNAL,
*which triggers the SLOT function SkyMap::slewFocus(). This
*function iteratively steps the Focus point toward Destination,
@@ -169,7 +169,7 @@ class SkyMap : public QGraphicsView {
*/
void setDestination( const SkyPoint& f );
- /**@short sets the destination point of the skymap, using ra/dec coordinates.
+ /** @short sets the destination point of the skymap, using ra/dec coordinates.
*
*@note This function behaves essentially like the above function.
*It differs only in the data types of its arguments.
@@ -179,18 +179,18 @@ class SkyMap : public QGraphicsView {
*/
void setDestination( const dms &ra, const dms &dec );
- /**@short sets the destination point of the sky map, using its alt/az coordinates.
+ /** @short sets the destination point of the sky map, using its alt/az coordinates.
*@param alt the new altitude
*@param az the new azimuth
*/
void setDestinationAltAz( const dms &alt, const dms & az);
- /**@short set the FocusPoint; the position that is to be the next Destination.
+ /** @short set the FocusPoint; the position that is to be the next Destination.
*@param f a pointer to the FocusPoint SkyPoint.
*/
void setFocusPoint( SkyPoint *f ) { if ( f ) FocusPoint = *f; }
- /**@short Retrieve the ClickedPoint position.
+ /** @short Retrieve the ClickedPoint position.
*
*When the user clicks on a point in the sky map, the sky coordinates of the mouse
*cursor are stored in the private member ClickedPoint. This function retrieves
@@ -199,12 +199,12 @@ class SkyMap : public QGraphicsView {
*/
SkyPoint* clickedPoint() { return &ClickedPoint; }
- /**@short Set the ClickedPoint to the skypoint given as an argument.
+ /** @short Set the ClickedPoint to the skypoint given as an argument.
*@param f pointer to the new ClickedPoint.
*/
void setClickedPoint( SkyPoint *f );
- /**@short Retrieve the object nearest to a mouse click event.
+ /** @short Retrieve the object nearest to a mouse click event.
*
*If the user clicks on the sky map, a pointer to the nearest SkyObject is stored in
*the private member ClickedObject. This function returns the ClickedObject pointer,
@@ -213,12 +213,12 @@ class SkyMap : public QGraphicsView {
*/
SkyObject* clickedObject() const { return ClickedObject; }
- /**@short Set the ClickedObject pointer to the argument.
+ /** @short Set the ClickedObject pointer to the argument.
*@param o pointer to the SkyObject to be assigned as the ClickedObject
*/
void setClickedObject( SkyObject *o );
- /**@short Retrieve the object which is centered in the sky map.
+ /** @short Retrieve the object which is centered in the sky map.
*
*If the user centers the sky map on an object (by double-clicking or using the
*Find Object dialog), a pointer to the "focused" object is stored in
@@ -228,7 +228,7 @@ class SkyMap : public QGraphicsView {
*/
SkyObject* focusObject() const { return FocusObject; }
- /**@short Set the FocusObject pointer to the argument.
+ /** @short Set the FocusObject pointer to the argument.
*@param o pointer to the SkyObject to be assigned as the FocusObject
*/
void setFocusObject( SkyObject *o );
@@ -236,7 +236,7 @@ class SkyMap : public QGraphicsView {
/** @short Call to set up the projector before a draw cycle. */
void setupProjector();
- /**@ Set zoom factor.
+ /** @ Set zoom factor.
*@param factor zoom factor
*/
void setZoomFactor(double factor);
@@ -244,10 +244,10 @@ class SkyMap : public QGraphicsView {
bool isSlewing() const;
// NOTE: This method is draw-backend independent.
- /**@short update the geometry of the angle ruler. */
+ /** @short update the geometry of the angle ruler. */
void updateAngleRuler();
- /**@return true if the object currently has a user label attached.
+ /** @return true if the object currently has a user label attached.
*@note this function only checks for a label explicitly added to the object
*with the right-click popup menu; other kinds of labels are not detected by
*this function.
@@ -300,7 +300,7 @@ public slots:
*/
void forceUpdate( bool now=false );
- /**@short Convenience function; simply calls forceUpdate(true).
+ /** @short Convenience function; simply calls forceUpdate(true).
* @see forceUpdate()
*/
void forceUpdateNow() { forceUpdate( true ); }
@@ -323,7 +323,7 @@ public slots:
*/
void slewFocus();
- /**@short Center the display at the point ClickedPoint.
+ /** @short Center the display at the point ClickedPoint.
*
* The essential part of the function is to simply set the Destination point, which will emit
* the destinationChanged() SIGNAL, which triggers the slewFocus() SLOT. Additionally, this
@@ -335,27 +335,27 @@ public slots:
*/
void slotCenter();
- /**@short Popup menu function: Display 1st-Generation DSS image with the Image Viewer.
+ /** @short Popup menu function: Display 1st-Generation DSS image with the Image Viewer.
* @note the URL is generated using the coordinates of ClickedPoint.
*/
void slotDSS();
- /**@short Popup menu function: Display Sloan Digital Sky Survey image with the Image Viewer.
+ /** @short Popup menu function: Display Sloan Digital Sky Survey image with the Image Viewer.
* @note the URL is generated using the coordinates of ClickedPoint.
*/
void slotSDSS();
- /**@short Popup menu function: Show webpage about ClickedObject
+ /** @short Popup menu function: Show webpage about ClickedObject
* (only available for some objects).
*/
void slotInfo();
- /**@short Popup menu function: Show image of ClickedObject
+ /** @short Popup menu function: Show image of ClickedObject
* (only available for some objects).
*/
void slotImage();
- /**@short Popup menu function: Show the Detailed Information window for ClickedObject. */
+ /** @short Popup menu function: Show the Detailed Information window for ClickedObject. */
void slotDetail();
/**Add ClickedObject to KStarsData::ObjLabelList, which stores pointers to SkyObjects which
@@ -368,7 +368,7 @@ public slots:
*/
void slotRemoveObjectLabel();
- /**@short Add a Planet Trail to ClickedObject.
+ /** @short Add a Planet Trail to ClickedObject.
* @note Trails are added simply by calling KSPlanetBase::addToTrail() to add the first point.
* as long as the trail is not empty, new points will be automatically appended to it.
* @note if ClickedObject is not a Solar System body, this function does nothing.
@@ -376,7 +376,7 @@ public slots:
*/
void slotAddPlanetTrail();
- /**@short Remove the PlanetTrail from ClickedObject.
+ /** @short Remove the PlanetTrail from ClickedObject.
* @note The Trail is removed by simply calling KSPlanetBase::clearTrail(). As long as
* the trail is empty, no new points will be automatically appended.
* @see KSPlanetBase::clearTrail()
@@ -409,16 +409,16 @@ public slots:
* in the status bar */
void slotCancelRulerMode();
- /**@short Open Flag Manager window with clickedObject() RA and Dec entered.
+ /** @short Open Flag Manager window with clickedObject() RA and Dec entered.
*/
void slotAddFlag();
- /**@short Open Flag Manager window with selected flag focused and ready to edit.
+ /** @short Open Flag Manager window with selected flag focused and ready to edit.
*@param flagIdx index of flag to be edited.
*/
void slotEditFlag( int flagIdx );
- /**@short Delete selected flag.
+ /** @short Delete selected flag.
*@param flagIdx index of flag to be deleted.
*/
void slotDeleteFlag( int flagIdx );
@@ -537,10 +537,10 @@ private slots:
private:
- /**@short Sets the shape of the default mouse cursor to a cross. */
+ /** @short Sets the shape of the default mouse cursor to a cross. */
void setDefaultMouseCursor();
- /**@short Sets the shape of the mouse cursor to a magnifying glass. */
+ /** @short Sets the shape of the mouse cursor to a magnifying glass. */
void setZoomMouseCursor();
/** Calculate the zoom factor for the given keyboard modifier
@@ -609,7 +609,7 @@ private:
KStarsData *data;
KSPopupMenu *pmenu;
- /**@short Coordinates of point under cursor. It's update in
+ /** @short Coordinates of point under cursor. It's update in
* function mouseMoveEvent
*/
SkyPoint m_MousePoint;
diff --git a/kstars/skymapdrawabstract.h b/kstars/skymapdrawabstract.h
index c9fc4f9..78aa896 100644
--- a/kstars/skymapdrawabstract.h
+++ b/kstars/skymapdrawabstract.h
@@ -43,7 +43,7 @@ class SkyMapDrawAbstract {
/**
*@short Virtual Destructor
*/
- virtual ~SkyMapDrawAbstract() { };
+ virtual ~SkyMapDrawAbstract() { }
public:
@@ -92,7 +92,7 @@ class SkyMapDrawAbstract {
void drawAngleRuler( QPainter &psky );
- /**@short Draw the current Sky map to a pixmap which is to be printed or exported to a file.
+ /** @short Draw the current Sky map to a pixmap which is to be printed or exported to a file.
*
*@param pd pointer to the QPaintDevice on which to draw.
*@see KStars::slotExportImage()
@@ -100,7 +100,7 @@ class SkyMapDrawAbstract {
*/
void exportSkyImage( QPaintDevice *pd, bool scale = false );
- /**@short Draw the current Sky map using passed SkyQPainter instance. Required when
+ /** @short Draw the current Sky map using passed SkyQPainter instance. Required when
* used QPaintDevice doesn't support drawing using multiple painters (e.g. QSvgGenerator
* which generates broken SVG output when more than one QPainter subclass is used).
* Passed painter should already be initialized to draw on selected QPaintDevice subclass
@@ -110,7 +110,7 @@ class SkyMapDrawAbstract {
*/
void exportSkyImage( SkyQPainter *painter, bool scale = false );
- /**@short Draw "user labels". User labels are name labels attached to objects manually with
+ /** @short Draw "user labels". User labels are name labels attached to objects manually with
* the right-click popup menu. Also adds a label to the FocusObject if the Option UseAutoLabel
* is true.
* @param labelObjects QList of pointers to the objects which need labels (excluding the centered object)
diff --git a/kstars/skyobjects/ksasteroid.h b/kstars/skyobjects/ksasteroid.h
index 9a0a35a..c7ed4bd 100644
--- a/kstars/skyobjects/ksasteroid.h
+++ b/kstars/skyobjects/ksasteroid.h
@@ -23,7 +23,7 @@
class KSNumbers;
class dms;
-/**@class KSAsteroid
+/** @class KSAsteroid
*@short A subclass of KSPlanetBase that implements asteroids.
*
*The orbital elements are stored as private member variables, and it
@@ -48,7 +48,7 @@ class KSAsteroid : public KSPlanetBase
{
public:
- /**Constructor.
+ /** Constructor.
*@p catN number of asteroid
*@p s the name of the asteroid
*@p image_file the filename for an image of the asteroid
@@ -68,15 +68,15 @@ public:
virtual KSAsteroid* clone() const;
virtual SkyObject::UID getUID() const;
- /**Destructor (empty)*/
+ /** Destructor (empty)*/
virtual ~KSAsteroid() {}
- /**This is inherited from KSPlanetBase. We don't use it in this class,
+ /** This is inherited from KSPlanetBase. We don't use it in this class,
*so it is empty.
*/
virtual bool loadData();
- /**This lets other classes like KSPlanetBase access H and G values
+ /** This lets other classes like KSPlanetBase access H and G values
*Used by KSPlanetBase::FindMagnitude
*/
double inline getAbsoluteMagnitude() const { return H; }
@@ -183,7 +183,7 @@ public:
inline float getPeriod() const { return Period; }
protected:
- /**Calculate the geocentric RA, Dec coordinates of the Asteroid.
+ /** Calculate the geocentric RA, Dec coordinates of the Asteroid.
*@note reimplemented from KSPlanetBase
*@param num time-dependent values for the desired date
*@param Earth planet Earth (needed to calculate geocentric coords)
diff --git a/kstars/skyobjects/kscomet.h b/kstars/skyobjects/kscomet.h
index 5555b09..b27e849 100644
--- a/kstars/skyobjects/kscomet.h
+++ b/kstars/skyobjects/kscomet.h
@@ -20,7 +20,7 @@
#include "ksplanetbase.h"
-/**@class KSComet
+/** @class KSComet
*@short A subclass of KSPlanetBase that implements comets.
*
*The orbital elements are stored as private member variables, and
@@ -50,7 +50,7 @@ class dms;
class KSComet : public KSPlanetBase
{
public:
- /**Constructor.
+ /** Constructor.
*@param s the name of the comet
*@param image_file the filename for an image of the comet
*@param JD the Julian Day for the orbital elements
@@ -72,10 +72,10 @@ public:
virtual KSComet* clone() const;
virtual SkyObject::UID getUID() const;
- /**Destructor (empty)*/
+ /** Destructor (empty)*/
virtual ~KSComet() {}
- /**Unused virtual function inherited from KSPlanetBase,
+ /** Unused virtual function inherited from KSPlanetBase,
*so it's simply empty here.
*/
virtual bool loadData();
@@ -229,7 +229,7 @@ public:
protected:
- /**Calculate the geocentric RA, Dec coordinates of the Comet.
+ /** Calculate the geocentric RA, Dec coordinates of the Comet.
*@note reimplemented from KSPlanetBase
*@param num time-dependent values for the desired date
*@param Earth planet Earth (needed to calculate geocentric coords)
diff --git a/kstars/skyobjects/ksmoon.h b/kstars/skyobjects/ksmoon.h
index e56cc65..6142f06 100644
--- a/kstars/skyobjects/ksmoon.h
+++ b/kstars/skyobjects/ksmoon.h
@@ -21,7 +21,7 @@
#include "ksplanetbase.h"
#include "dms.h"
-/**@class KSMoon
+/** @class KSMoon
*A subclass of SkyObject that provides information
*needed for the Moon. Specifically, KSMoon provides a moon-specific
*findPosition() function. Also, there is a method findPhase(), which returns
@@ -45,7 +45,7 @@ public:
virtual KSMoon* clone() const;
virtual SkyObject::UID getUID() const;
- /**Destructor (empty). */
+ /** Destructor (empty). */
~KSMoon();
/**
@@ -56,10 +56,10 @@ public:
*/
virtual void findPhase( const KSSun *Sun = 0 );
- /**@return the illuminated fraction of the Moon as seen from Earth */
+ /** @return the illuminated fraction of the Moon as seen from Earth */
double illum() const { return 0.5*(1.0 - cos( Phase * dms::PI / 180.0 ) ); }
- /**@return a short string describing the moon's phase */
+ /** @return a short string describing the moon's phase */
QString phaseName() const;
/** reimplemented from KSPlanetBase */
@@ -95,7 +95,7 @@ private:
static bool data_loaded;
static int instance_count;
- /**@class MoonLRData
+ /** @class MoonLRData
* Encapsulates the Longitude and radius terms of the sums
* used to compute the moon's position.
* @short Moon Longitude and radius data object
@@ -113,7 +113,7 @@ private:
static QList<MoonLRData> LRData;
- /**@class MoonBData
+ /** @class MoonBData
* Encapsulates the Latitude terms of the sums
* used to compute the moon's position.
* @short Moon Latitude data object
diff --git a/kstars/skyobjects/ksplanet.h b/kstars/skyobjects/ksplanet.h
index c6a91b6..4660c0d 100644
--- a/kstars/skyobjects/ksplanet.h
+++ b/kstars/skyobjects/ksplanet.h
@@ -24,7 +24,7 @@
#include "ksplanetbase.h"
#include "dms.h"
-/**@class KSPlanet
+/** @class KSPlanet
*A subclass of KSPlanetBase for seven of the major planets in the solar system
*(Earth and Pluto have their own specialized classes derived from KSPlanetBase).
*@note The Sun is subclassed from KSPlanet.
@@ -65,17 +65,17 @@ public:
*/
virtual ~KSPlanet() {}
- /**@short return the untranslated name
+ /** @short return the untranslated name
*This is a dirty way to solve a lot of localization-related trouble for the KDE 4.2 release
*TODO: Change the whole architecture for names later
*/
QString untranslatedName( void ) const;
- /**@short Preload the data used by findPosition.
+ /** @short Preload the data used by findPosition.
*/
virtual bool loadData();
- /**Calculate the ecliptic longitude and latitude of the planet for
+ /** Calculate the ecliptic longitude and latitude of the planet for
*the given date (expressed in Julian Millenia since J2000). A reference
*to the ecliptic coordinates is returned as the second object.
*@param jm Julian Millenia (=jd/1000)
@@ -87,7 +87,7 @@ protected:
bool data_loaded;
- /**Calculate the geocentric RA, Dec coordinates of the Planet.
+ /** Calculate the geocentric RA, Dec coordinates of the Planet.
*@note reimplemented from KSPlanetBase
*@param num pointer to object with time-dependent values for the desired date
*@param Earth pointer to the planet Earth (needed to calculate geocentric coords)
@@ -95,7 +95,7 @@ protected:
*/
virtual bool findGeocentricPosition( const KSNumbers *num, const KSPlanetBase *Earth=NULL );
- /**@class OrbitData
+ /** @class OrbitData
*This class contains doubles A,B,C which represent a single term in a planet's
*positional expansion sums (each sum-term is A*COS(B+C*T)).
*@author Mark Hollomon
@@ -125,7 +125,7 @@ protected:
typedef QVector<OrbitData> OBArray[6];
- /**OrbitDataColl contains three groups of six QVectors. Each QVector is a
+ /** OrbitDataColl contains three groups of six QVectors. Each QVector is a
*list of OrbitData objects, representing a single sum used in computing
*the planet's position. A set of six of these vectors comprises the large
*"meta-sum" which yields the planet's Longitude, Latitude, or Distance value.
@@ -143,7 +143,7 @@ protected:
};
- /**OrbitDataManager places the OrbitDataColl objects for all planets in a QDict
+ /** OrbitDataManager places the OrbitDataColl objects for all planets in a QDict
*indexed by the planets' names. It also loads the positional data of each planet
*from disk.
*@author Mark Hollomon
@@ -151,10 +151,10 @@ protected:
*/
class OrbitDataManager {
public:
- /**Constructor*/
+ /** Constructor*/
OrbitDataManager();
- /**Load orbital data for a planet from disk.
+ /** Load orbital data for a planet from disk.
*The data is stored on disk in a series of files named
*"name.[LBR][0...5].vsop", where "L"=Longitude data, "B"=Latitude data,
*and R=Radius data.
@@ -165,7 +165,7 @@ protected:
bool loadData( OrbitDataColl &odc, const QString &n);
private:
- /**Read a single orbital data file from disk into an OrbitData vector.
+ /** Read a single orbital data file from disk into an OrbitData vector.
*The data files are named "name.[LBR][0...5].vsop", where
*"L"=Longitude data, "B"=Latitude data, and R=Radius data.
*@param fname the filename to be read.
diff --git a/kstars/skyobjects/ksplanetbase.h b/kstars/skyobjects/ksplanetbase.h
index 163c30c..cb1dd28 100644
--- a/kstars/skyobjects/ksplanetbase.h
+++ b/kstars/skyobjects/ksplanetbase.h
@@ -91,28 +91,28 @@ public:
/** @return pointer to Ecliptic Latitude coordinate */
const dms& ecLat() const { return ep.latitude; }
- /**@short Set Ecliptic Geocentric Longitude according to argument.
+ /** @short Set Ecliptic Geocentric Longitude according to argument.
* @param elong Ecliptic Longitude
*/
void setEcLong( dms elong ) { ep.longitude = elong; }
- /**@short Set Ecliptic Geocentric Latitude according to argument.
+ /** @short Set Ecliptic Geocentric Latitude according to argument.
* @param elat Ecliptic Latitude
*/
void setEcLat( dms elat ) { ep.latitude = elat; }
- /**@return pointer to Ecliptic Heliocentric Longitude coordinate */
+ /** @return pointer to Ecliptic Heliocentric Longitude coordinate */
const dms& helEcLong() const { return helEcPos.longitude; }
- /**@return pointer to Ecliptic Heliocentric Latitude coordinate */
+ /** @return pointer to Ecliptic Heliocentric Latitude coordinate */
const dms& helEcLat() const { return helEcPos.latitude; }
- /**@short Convert Ecliptic logitude/latitude to Right Ascension/Declination.
+ /** @short Convert Ecliptic logitude/latitude to Right Ascension/Declination.
* @param Obliquity current Obliquity of the Ecliptic (angle from Equator)
*/
void EclipticToEquatorial( const dms *Obliquity );
- /**@short Convert Right Ascension/Declination to Ecliptic logitude/latitude.
+ /** @short Convert Right Ascension/Declination to Ecliptic logitude/latitude.
* @param Obliquity current Obliquity of the Ecliptic (angle from Equator)
*/
void EquatorialToEcliptic( const dms *Obliquity );
@@ -120,23 +120,23 @@ public:
/** @return pointer to this planet's texture */
const QImage& image() const { return m_image; }
- /**@return distance from Sun, in Astronomical Units (1 AU is Earth-Sun distance) */
+ /** @return distance from Sun, in Astronomical Units (1 AU is Earth-Sun distance) */
double rsun() const { return ep.radius; }
- /**@short Set the solar distance in AU.
+ /** @short Set the solar distance in AU.
* @param r the new solar distance in AU
*/
void setRsun( double r ) { ep.radius = r; }
- /**@return distance from Earth, in Astronomical Units (1 AU is Earth-Sun distance) */
+ /** @return distance from Earth, in Astronomical Units (1 AU is Earth-Sun distance) */
double rearth() const { return Rearth; }
- /**@short Set the distance from Earth, in AU.
+ /** @short Set the distance from Earth, in AU.
* @param r the new earth-distance in AU
*/
void setRearth( double r ) { Rearth = r; }
- /**@short compute and set the distance from Earth, in AU.
+ /** @short compute and set the distance from Earth, in AU.
* @param Earth pointer to the Earth from which to calculate the distance.
*/
void setRearth( const KSPlanetBase *Earth );
@@ -149,7 +149,7 @@ public:
*/
virtual void updateCoords( KSNumbers *num, bool includePlanets=true, const dms *lat=0, const dms *LST=0, bool forceRecompute = false );
- /**@short Find position, including correction for Figure-of-the-Earth.
+ /** @short Find position, including correction for Figure-of-the-Earth.
* @param num KSNumbers pointer for the target date/time
* @param lat pointer to the geographic latitude; if NULL, we skip localizeCoords()
* @param LST pointer to the local sidereal time; if NULL, we skip localizeCoords()
@@ -160,7 +160,7 @@ public:
/** @return the Planet's position angle. */
virtual double pa() const { return PositionAngle; }
- /**@short Set the Planet's position angle.
+ /** @short Set the Planet's position angle.
* @param p the new position angle
*/
void setPA( double p ) { PositionAngle = p; }
@@ -168,7 +168,7 @@ public:
/** @return the Planet's angular size, in arcminutes */
double angSize() const { return AngularSize; }
- /**@short set the planet's angular size, in km.
+ /** @short set the planet's angular size, in km.
* @param size the planet's size, in km
*/
void setAngularSize( double size ) { AngularSize = size; }
@@ -176,7 +176,7 @@ public:
/** @return the Planet's physical size, in km */
double physicalSize() const { return PhysicalSize; }
- /**@short set the planet's physical size, in km.
+ /** @short set the planet's physical size, in km.
* @param size the planet's size, in km
*/
void setPhysicalSize( double size ) { PhysicalSize = size; }
@@ -207,7 +207,7 @@ protected:
/** Compute high 32-bits of UID. */
inline UID solarsysUID(UID type) const { return (SkyObject::UID_SOLARSYS << 60) | (type << 56); }
- /**@short find the object's current geocentric equatorial coordinates (RA and Dec)
+ /** @short find the object's current geocentric equatorial coordinates (RA and Dec)
* This function is pure virtual; it must be overloaded by subclasses.
* This function is private; it is called by the public function findPosition()
* which also includes the figure-of-the-earth correction, localizeCoords().
diff --git a/kstars/skyobjects/kspluto.h b/kstars/skyobjects/kspluto.h
index 942bf18..e38f51e 100644
--- a/kstars/skyobjects/kspluto.h
+++ b/kstars/skyobjects/kspluto.h
@@ -20,7 +20,7 @@
#include "ksasteroid.h"
-/**@class KSPluto
+/** @class KSPluto
*A subclass of KSAsteroid that represents the planet Pluto. Now, we
*are certainly NOT claiming that Pluto is an asteroid. However, the
*findPosition() routines of KSPlanet do not work properly for Pluto.
@@ -42,7 +42,7 @@
class KSPluto : public KSAsteroid {
public:
- /**Constructor. Calls KSAsteroid constructor with name="Pluto", and fills
+ /** Constructor. Calls KSAsteroid constructor with name="Pluto", and fills
*in orbital element data (which is hard-coded for now).
*@param kd pointer to the KStarsData object
*@param fn filename of Pluto's image
@@ -56,7 +56,7 @@ public:
virtual ~KSPluto();
protected:
- /**A custom findPosition() function for Pluto. Computes the values of the
+ /** A custom findPosition() function for Pluto. Computes the values of the
*orbital elements on the requested date, and calls KSAsteroid::findGeocentricPosition()
*using those elements.
*@param num time-dependent values for the desired date
diff --git a/kstars/skyobjects/kssun.h b/kstars/skyobjects/kssun.h
index 96c5ba7..7091208 100644
--- a/kstars/skyobjects/kssun.h
+++ b/kstars/skyobjects/kssun.h
@@ -21,7 +21,7 @@
#include <QString>
#include "ksplanet.h"
-/**@class KSSun
+/** @class KSSun
*Child class of KSPlanetBase; encapsulates information about the Sun.
*@short Provides necessary information about the Sun.
*@author Mark Hollomon
@@ -30,7 +30,7 @@
class KSSun : public KSPlanet {
public:
- /**Constructor. Defines constants needed by findPosition().
+ /** Constructor. Defines constants needed by findPosition().
*Sets Ecliptic coordinates appropriate for J2000.
*@param kd pointer to KStarsData object
*/
@@ -39,11 +39,11 @@ public:
virtual KSSun* clone() const;
virtual SkyObject::UID getUID() const;
- /**Destructor (empty)
+ /** Destructor (empty)
*/
virtual ~KSSun() {}
- /**Read orbital data from disk
+ /** Read orbital data from disk
*@note reimplemented from KSPlanet
*@note we actually read Earth's orbital data. The Sun's geocentric
*ecliptic coordinates are by definition exactly the opposite of the
@@ -53,7 +53,7 @@ public:
protected:
- /**Determine geocentric RA, Dec coordinates for the Epoch given in the argument.
+ /** Determine geocentric RA, Dec coordinates for the Epoch given in the argument.
*@p Epoch current Julian Date
*@p Earth pointer to earth object
*/
diff --git a/kstars/skyobjects/skyline.h b/kstars/skyobjects/skyline.h
index fe968b5..f806518 100644
--- a/kstars/skyobjects/skyline.h
+++ b/kstars/skyobjects/skyline.h
@@ -48,7 +48,7 @@ public:
*/
void append( SkyPoint *p );
- /**@return a const pointer to a point in the SkyLine
+ /** @return a const pointer to a point in the SkyLine
* param i the index position of the point
*/
inline SkyPoint* point( int i ) const { return m_pList[i]; }
@@ -64,7 +64,7 @@ public:
*/
void setPoint( int i, SkyPoint *p );
- /**@return the angle subtended by any line segment along the SkyLine.
+ /** @return the angle subtended by any line segment along the SkyLine.
* @param i the index of the line segment to be measured.
* If no argument is given, the first segment is assumed.
*/
diff --git a/kstars/skyobjects/skypoint.h b/kstars/skyobjects/skypoint.h
index 43a7974..fd2e881 100644
--- a/kstars/skyobjects/skypoint.h
+++ b/kstars/skyobjects/skypoint.h
@@ -29,7 +29,7 @@
class KSNumbers;
class KSSun;
-/**@class SkyPoint
+/** @class SkyPoint
*
*The sky coordinates of a point in the sky. The
*coordinates are stored in both Equatorial (Right Ascension,
@@ -49,7 +49,7 @@ class KSSun;
*/
class SkyPoint {
public:
- /**Default constructor: Sets RA, Dec and RA0, Dec0 according
+ /** Default constructor: Sets RA, Dec and RA0, Dec0 according
*to arguments. Does not set Altitude or Azimuth.
*@param r Right Ascension
*@param d Declination
@@ -62,7 +62,7 @@ public:
{}
- /**Alternate constructor using double arguments, for convenience.
+ /** Alternate constructor using double arguments, for convenience.
*It behaves essentially like the default constructor.
*@param r Right Ascension, expressed as a double
*@param d Declination, expressed as a double
@@ -98,67 +98,67 @@ public:
*/
void set( const dms& r, const dms& d );
- /**Sets RA0, the catalog Right Ascension.
+ /** Sets RA0, the catalog Right Ascension.
*@param r catalog Right Ascension.
*/
inline void setRA0( dms r ) { RA0 = r; }
- /**Overloaded member function, provided for convenience.
+ /** Overloaded member function, provided for convenience.
*It behaves essentially like the above function.
*@param r Right Ascension, expressed as a double.
*/
inline void setRA0( double r ) { RA0.setH( r ); }
- /**Sets Dec0, the catalog Declination.
+ /** Sets Dec0, the catalog Declination.
*@param d catalog Declination.
*/
inline void setDec0( dms d ) { Dec0 = d; }
- /**Overloaded member function, provided for convenience.
+ /** Overloaded member function, provided for convenience.
*It behaves essentially like the above function.
*@param d Declination, expressed as a double.
*/
inline void setDec0( double d ) { Dec0.setD( d ); }
- /**Sets RA, the current Right Ascension.
+ /** Sets RA, the current Right Ascension.
*@param r Right Ascension.
*/
inline void setRA( dms r ) { RA = r; }
- /**Overloaded member function, provided for convenience.
+ /** Overloaded member function, provided for convenience.
*It behaves essentially like the above function.
*@param r Right Ascension, expressed as a double.
*/
inline void setRA( double r ) { RA.setH( r ); }
- /**Sets Dec, the current Declination
+ /** Sets Dec, the current Declination
*@param d Declination.
*/
inline void setDec( dms d ) { Dec = d; }
- /**Overloaded member function, provided for convenience.
+ /** Overloaded member function, provided for convenience.
*It behaves essentially like the above function.
*@param d Declination, expressed as a double.
*/
inline void setDec( double d ) { Dec.setD( d ); }
- /**Sets Alt, the Altitude.
+ /** Sets Alt, the Altitude.
*@param alt Altitude.
*/
inline void setAlt( dms alt ) { Alt = alt; }
- /**Overloaded member function, provided for convenience.
+ /** Overloaded member function, provided for convenience.
*It behaves essentially like the above function.
*@param alt Altitude, expressed as a double.
*/
inline void setAlt( double alt ) { Alt.setD( alt ); }
- /**Sets Az, the Azimuth.
+ /** Sets Az, the Azimuth.
*@param az Azimuth.
*/
inline void setAz( dms az ) { Az = az; }
- /**Overloaded member function, provided for convenience.
+ /** Overloaded member function, provided for convenience.
*It behaves essentially like the above function.
*@param az Azimuth, expressed as a double.
*/
@@ -168,25 +168,25 @@ public:
//// 2. Returning coordinates.
//// =========================
- /**@return a pointer to the catalog Right Ascension. */
+ /** @return a pointer to the catalog Right Ascension. */
inline const dms& ra0() const { return RA0; }
- /**@return a pointer to the catalog Declination. */
+ /** @return a pointer to the catalog Declination. */
inline const dms& dec0() const { return Dec0; }
- /**@returns a pointer to the current Right Ascension. */
+ /** @returns a pointer to the current Right Ascension. */
inline const dms& ra() const { return RA; }
- /**@return a pointer to the current Declination. */
+ /** @return a pointer to the current Declination. */
inline const dms& dec() const { return Dec; }
- /**@return a pointer to the current Azimuth. */
+ /** @return a pointer to the current Azimuth. */
inline const dms& az() const { return Az; }
- /**@return a pointer to the current Altitude. */
+ /** @return a pointer to the current Altitude. */
inline const dms& alt() const { return Alt; }
- /**@return refracted altitude. This function uses
+ /** @return refracted altitude. This function uses
* Options::useRefraction to determine whether refraction
* correction should be applied */
dms altRefracted() const;
@@ -195,7 +195,7 @@ public:
//// 3. Coordinate conversions.
//// ==========================
- /**Determine the (Altitude, Azimuth) coordinates of the
+ /** Determine the (Altitude, Azimuth) coordinates of the
*SkyPoint from its (RA, Dec) coordinates, given the local
*sidereal time and the observer's latitude.
*@param LST pointer to the local sidereal time
@@ -203,7 +203,7 @@ public:
*/
void EquatorialToHorizontal( const dms* LST, const dms* lat );
- /**Determine the (RA, Dec) coordinates of the
+ /** Determine the (RA, Dec) coordinates of the
*SkyPoint from its (Altitude, Azimuth) coordinates, given the local
*sidereal time and the observer's latitude.
*@param LST pointer to the local sidereal time
@@ -211,13 +211,13 @@ public:
*/
void HorizontalToEquatorial( const dms* LST, const dms* lat );
- /**Determine the Ecliptic coordinates of the SkyPoint, given the Julian Date.
+ /** Determine the Ecliptic coordinates of the SkyPoint, given the Julian Date.
*The ecliptic coordinates are returned as reference arguments (since
*they are not stored internally)
*/
void findEcliptic( const dms *Obliquity, dms &EcLong, dms &EcLat );
- /**Set the current (RA, Dec) coordinates of the
+ /** Set the current (RA, Dec) coordinates of the
*SkyPoint, given pointers to its Ecliptic (Long, Lat) coordinates, and
*to the current obliquity angle (the angle between the equator and ecliptic).
*/
@@ -239,7 +239,7 @@ public:
//// 4. Coordinate update/corrections.
//// =================================
- /**Determine the current coordinates (RA, Dec) from the catalog
+ /** Determine the current coordinates (RA, Dec) from the catalog
*coordinates (RA0, Dec0), accounting for both precession and nutation.
*@param num pointer to KSNumbers object containing current values of
*time-dependent variables.
@@ -250,7 +250,7 @@ public:
*/
virtual void updateCoords( KSNumbers *num, bool includePlanets=true, const dms *lat=0, const dms *LST=0, bool forceRecompute = false );
- /**Computes the apparent coordinates for this SkyPoint for any epoch,
+ /** Computes the apparent coordinates for this SkyPoint for any epoch,
*accounting for the effects of precession, nutation, and aberration.
*Similar to updateCoords(), but the starting epoch need not be
*J2000, and the target epoch need not be the present time.
@@ -259,7 +259,7 @@ public:
*/
void apparentCoord(long double jd0, long double jdf);
- /**Determine the effects of nutation for this SkyPoint.
+ /** Determine the effects of nutation for this SkyPoint.
*@param num pointer to KSNumbers object containing current values of
*time-dependent variables.
*/
@@ -271,7 +271,7 @@ public:
*/
bool checkBendLight();
- /**Correct for the effect of "bending" of light around the sun for
+ /** Correct for the effect of "bending" of light around the sun for
* positions near the sun.
*
* General Relativity tells us that a photon with an impact
@@ -289,13 +289,13 @@ public:
*/
SkyPoint deprecess( const KSNumbers *num, long double epoch=J2000 );
- /**Determine the effects of aberration for this SkyPoint.
+ /** Determine the effects of aberration for this SkyPoint.
*@param num pointer to KSNumbers object containing current values of
*time-dependent variables.
*/
void aberrate(const KSNumbers *num);
- /**General case of precession. It precess from an original epoch to a
+ /** General case of precession. It precess from an original epoch to a
*final epoch. In this case RA0, and Dec0 from SkyPoint object represent
*the coordinates for the original epoch and not for J2000, as usual.
*@param jd0 Julian Day which identifies the original epoch
diff --git a/kstars/skyobjects/starobject.h b/kstars/skyobjects/starobject.h
index cc4b881..0047f74 100644
--- a/kstars/skyobjects/starobject.h
+++ b/kstars/skyobjects/starobject.h
@@ -27,7 +27,7 @@
class KSPopupMenu;
-/**@class StarObject
+/** @class StarObject
*This is a subclass of SkyObject. It adds the Spectral type, and flags
*for variability and multiplicity.
*For stars, the primary name (n) is the latin name (e.g., "Betelgeuse"). The
@@ -132,7 +132,7 @@ public:
/** If star is unnamed return "star" otherwise return the longname */
inline virtual QString longname( void ) const { return hasLongName() ? LongName : starString; }
- /**Returns entire spectral type string
+ /** Returns entire spectral type string
* @return Spectral Type string
*/
QString sptype( void ) const;
@@ -140,21 +140,21 @@ public:
/** Returns just the first character of the spectral type string. */
char spchar() const;
- /**Returns the genetive name of the star.
+ /** Returns the genetive name of the star.
* @return genetive name of the star
*/
QString gname( bool useGreekChars=true ) const;
- /**Returns the greek letter portion of the star's genetive name.
+ /** Returns the greek letter portion of the star's genetive name.
* Returns empty string if star has no genetive name defined.
* @return greek letter portion of genetive name
*/
QString greekLetter( bool useGreekChars=true ) const;
- /**@return the genitive form of the star's constellation. */
+ /** @return the genitive form of the star's constellation. */
QString constell( void ) const;
- /**Determine the current coordinates (RA, Dec) from the catalog
+ /** Determine the current coordinates (RA, Dec) from the catalog
* coordinates (RA0, Dec0), accounting for both precession and nutation.
* @param num pointer to KSNumbers object containing current values of
* time-dependent variables.
@@ -164,7 +164,7 @@ public:
*/
virtual void updateCoords( KSNumbers *num, bool includePlanets=true, const dms *lat=0, const dms *LST=0, bool forceRecompute = false );
- /* @short fills ra and dec with the coordinates of the star with the proper
+ /** @short fills ra and dec with the coordinates of the star with the proper
* motion correction but without precesion and its friends. It is used
* in StarComponent to re-index all the stars.
*
@@ -172,10 +172,10 @@ public:
*/
void getIndexCoords( KSNumbers *num, double *ra, double *dec );
- /**@short added for JIT updates from both StarComponent and ConstellationLines */
+ /** @short added for JIT updates from both StarComponent and ConstellationLines */
void JITupdate();
- /**@short returns the magnitude of the proper motion correction in milliarcsec/year */
+ /** @short returns the magnitude of the proper motion correction in milliarcsec/year */
inline double pmMagnitude() const
{
double cosDec = dec0().cos();
@@ -192,48 +192,48 @@ public:
return (metric_weighted_pmRA * metric_weighted_pmRA + pmDec() * pmDec());
}
- /**@short Set the Ra and Dec components of the star's proper motion, in milliarcsec/year.
+ /** @short Set the Ra and Dec components of the star's proper motion, in milliarcsec/year.
* Note that the RA component is multiplied by cos(dec).
* @param pmra the new RA propoer motion
* @param pmdec the new Dec proper motion
*/
inline void setProperMotion( double pmra, double pmdec ) { PM_RA = pmra; PM_Dec = pmdec; }
- /**@return the RA component of the star's proper motion, in mas/yr (multiplied by cos(dec)) */
+ /** @return the RA component of the star's proper motion, in mas/yr (multiplied by cos(dec)) */
inline double pmRA() const { return PM_RA; }
- /**@return the Dec component of the star's proper motion, in mas/yr */
+ /** @return the Dec component of the star's proper motion, in mas/yr */
inline double pmDec() const { return PM_Dec; }
- /**@short set the star's parallax angle, in milliarcsec */
+ /** @short set the star's parallax angle, in milliarcsec */
inline void setParallax( double plx ) { Parallax = plx; }
- /**@return the star's parallax angle, in milliarcsec */
+ /** @return the star's parallax angle, in milliarcsec */
inline double parallax() const { return Parallax; }
- /**@return the star's distance from the Sun in parsecs, as computed from the parallax. */
+ /** @return the star's distance from the Sun in parsecs, as computed from the parallax. */
inline double distance() const { return 1000./parallax(); }
- /**@short set the star's multiplicity flag (i.e., is it a binary or multiple star?)
+ /** @short set the star's multiplicity flag (i.e., is it a binary or multiple star?)
* @param m true if binary/multiple star system */
inline void setMultiple( bool m ) { Multiplicity = m; }
- /**@return whether the star is a binary or multiple starobject */
+ /** @return whether the star is a binary or multiple starobject */
inline bool isMultiple() const { return Multiplicity; }
- /**@return the star's HD index */
+ /** @return the star's HD index */
inline int getHDIndex() const { return HD; }
- /**@short set the star's variability flag
+ /** @short set the star's variability flag
*@param v true if star is variable
*/
inline void setVariable( bool v ) { Variability = v; }
- /**@return whether the star is a binary or multiple starobject
+ /** @return whether the star is a binary or multiple starobject
*/
inline bool isVariable() const { return Variability; }
- /* @short returns the name, the magnitude or both.
+ /** @short returns the name, the magnitude or both.
*/
QString nameLabel( bool drawName, bool drawMag ) const;
diff --git a/kstars/thumbnailpicker.h b/kstars/thumbnailpicker.h
index 8829ea7..355c4cf 100644
--- a/kstars/thumbnailpicker.h
+++ b/kstars/thumbnailpicker.h
@@ -38,7 +38,7 @@ public:
explicit ThumbnailPickerUI( QWidget *p );
};
-/**@short Dialog for modifying an object's thumbnail image
+/** @short Dialog for modifying an object's thumbnail image
*@author Jason Harris
*/
class ThumbnailPicker : public QDialog
diff --git a/kstars/timezonerule.h b/kstars/timezonerule.h
index ea8953d..5048e61 100644
--- a/kstars/timezonerule.h
+++ b/kstars/timezonerule.h
@@ -18,7 +18,7 @@
#ifndef TIMEZONERULE_H_
#define TIMEZONERULE_H_
-/**@class TimeZoneRule
+/** @class TimeZoneRule
*This class provides the information needed to determine whether Daylight
*Savings Time (DST; a.k.a. "Summer Time") is currently active at a given
*location. There are (at least) 25 different "rules" which govern DST
@@ -55,10 +55,10 @@
class TimeZoneRule {
public:
- /**Default Constructor. Makes the "empty" time zone rule (i.e., no DST correction)*/
+ /** Default Constructor. Makes the "empty" time zone rule (i.e., no DST correction)*/
TimeZoneRule();
- /**Constructor. Create a TZ rule according to the arguments.
+ /** Constructor. Create a TZ rule according to the arguments.
*@param smonth the three-letter code for the month in which DST starts
*@param sday a string encoding the day on which DST starts (see the class description)
*@param stime the time at which DST starts
@@ -70,12 +70,12 @@ public:
TimeZoneRule( const QString &smonth, const QString &sday, const QTime &stime,
const QString &rmonth, const QString &rday, const QTime &rtime, const double &offset=1.00 );
- /**Determine whether DST is in effect for the given DateTime, according to this rule
+ /** Determine whether DST is in effect for the given DateTime, according to this rule
*@param date the date/time to test for DST
*/
bool isDSTActive( const KStarsDateTime &date );
- /**@return true if the rule is the "empty" TZ rule. */
+ /** @return true if the rule is the "empty" TZ rule. */
bool isEmptyRule() const { return ( HourOffset == 0.0 ); }
/** Toggle DST on/off. The @p activate argument should probably be isDSTActive()
@@ -83,7 +83,7 @@ public:
*/
void setDST( bool activate=true );
- /**@return the current Timezone offset, compared to the timezone's Standard Time.
+ /** @return the current Timezone offset, compared to the timezone's Standard Time.
*This is typically 0.0 if DST is inactive, and 1.0 if DST is active. */
double deltaTZ() const { return dTZ; }
@@ -99,35 +99,35 @@ public:
void reset_with_ltime( KStarsDateTime <ime, const double TZoffset, const bool time_runs_forward,
const bool automaticDSTchange = false );
- /**@return computed value for next DST change in universal time. */
+ /** @return computed value for next DST change in universal time. */
KStarsDateTime nextDSTChange() const { return next_change_utc; }
- /**@return computed value for next DST change in local time. */
+ /** @return computed value for next DST change in local time. */
KStarsDateTime nextDSTChange_LTime() const { return next_change_ltime; }
- /**@return true if this rule is the same as the argument.
+ /** @return true if this rule is the same as the argument.
* @param r the rule to check for equivalence
*/
bool equals( TimeZoneRule *r );
private:
- /**@return the KStarsDateTime of the moment when the next DST change will occur in local time
+ /** @return the KStarsDateTime of the moment when the next DST change will occur in local time
*This is useful because DST change times are saved in local times*/
void nextDSTChange_LTime( const KStarsDateTime &date );
- /**@return the KStarsDateTime of the moment when the last DST change occurred in local time
+ /** @return the KStarsDateTime of the moment when the last DST change occurred in local time
*This is useful because DST change times are saved in local times
*We need this in case time is running backwards. */
void previousDSTChange_LTime( const KStarsDateTime &date );
- /**calculate the next DST change in universal time for current location */
+ /** calculate the next DST change in universal time for current location */
void nextDSTChange( const KStarsDateTime &local_date, const double TZoffset );
- /**calculate the previous DST change in universal time for current location */
+ /** calculate the previous DST change in universal time for current location */
void previousDSTChange( const KStarsDateTime &local_date, const double TZoffset );
- /**Interpret the string as a month of the year;
+ /** Interpret the string as a month of the year;
*@return the month integer (1=jan ... 12=dec)
*/
int initMonth( const QString &m );
@@ -135,7 +135,7 @@ private:
/** Set up empty time zone rule */
void setEmpty();
- /**Interpret the day string as a week ID and a day-of-week ID. The day-of-week
+ /** Interpret the day string as a week ID and a day-of-week ID. The day-of-week
*is an integer between 1 (sunday) and 7 (saturday); the week integer can
*be 1-3 (1st/2nd/third weekday of the month), or 5 (last weekday of the month)
*@param day the day integer is returned by reference through this value
@@ -144,13 +144,13 @@ private:
*/
bool initDay( const QString &d, int &day, int &week );
- /**Find the calendar date on which DST starts for the calendar year
+ /** Find the calendar date on which DST starts for the calendar year
*of the given KStarsDateTime.
*@param d the date containing the year to be tested
*@return the calendar date, an integer between 1 and 31. */
int findStartDay( const KStarsDateTime &d );
- /**Find the calendar date on which DST ends for the calendar year
+ /** Find the calendar date on which DST ends for the calendar year
*of the given KStarsDateTime.
*@param d the date containing the year to be tested
*@return the calendar date, an integer between 1 and 31. */
diff --git a/kstars/tools/altvstime.h b/kstars/tools/altvstime.h
index 42f5824..5b160b9 100644
--- a/kstars/tools/altvstime.h
+++ b/kstars/tools/altvstime.h
@@ -34,7 +34,7 @@ public:
explicit AltVsTimeUI( QWidget *p=0 );
};
-/**@class AltVsTime
+/** @class AltVsTime
* @short the Altitude vs. Time Tool.
* Plot the altitude as a function of time for any list of
* objects, as seen from any location, on any date.
@@ -64,7 +64,7 @@ public:
*/
void showCurrentDate ();
- /**@return a KStarsDateTime object constructed from the
+ /** @return a KStarsDateTime object constructed from the
* current setting in the Date widget.
*/
KStarsDateTime getDate ();
@@ -84,7 +84,7 @@ public:
*/
double getEpoch( const QString &eName );
- /**@short Add a SkyObject to the display.
+ /** @short Add a SkyObject to the display.
* Constructs a PLotObject representing the Alt-vs-time curve for the object.
* @param o pointer to the SkyObject to be added
* @param forceAdd if true, then the object will be added, even if there
@@ -92,7 +92,7 @@ public:
*/
void processObject( SkyObject *o, bool forceAdd=false );
- /**@short Determine the altitude coordinate of a SkyPoint,
+ /** @short Determine the altitude coordinate of a SkyPoint,
* given an hour of the day.
*
* This is called for every 30-minute interval in the displayed Day,
@@ -103,35 +103,35 @@ public:
*/
double findAltitude( SkyPoint *p, double hour );
- /**@short get object name. If star has no name, generate a name based on catalog number.
+ /** @short get object name. If star has no name, generate a name based on catalog number.
* @param translated set to true if the translated name is required.
*/
QString getObjectName(const SkyObject *o, bool translated=true);
public slots:
- /**@short Update the plot to reflec new Date and Location settings. */
+ /** @short Update the plot to reflec new Date and Location settings. */
void slotUpdateDateLoc();
- /**@short Clear the list of displayed objects. */
+ /** @short Clear the list of displayed objects. */
void slotClear();
- /**@short Clear the edit boxes for specifying a new object. */
+ /** @short Clear the edit boxes for specifying a new object. */
void slotClearBoxes();
- /**@short Add an object to the list of displayed objects, according
+ /** @short Add an object to the list of displayed objects, according
* to the data entered in the edit boxes.
*/
void slotAddSource();
- /**@short Launch the Find Object window to select a new object for
+ /** @short Launch the Find Object window to select a new object for
* the list of displayed objects.
*/
void slotBrowseObject();
- /**@short Launch the Location dialog to choose a new location. */
+ /** @short Launch the Location dialog to choose a new location. */
void slotChooseCity();
- /**@short Move input keyboard focus to the next logical widget.
+ /** @short Move input keyboard focus to the next logical widget.
* We need a separate slot for this because we are intercepting
* Enter key events, which close the window by default, to
* advance input focus instead (when the Enter events occur in
@@ -144,12 +144,12 @@ public slots:
*/
void slotHighlight(int);
- /**@short Print plot widget
+ /** @short Print plot widget
*/
void slotPrint();
private:
- /**@short find start of dawn, end of dusk, maximum and minimum elevation of the sun */
+ /** @short find start of dawn, end of dusk, maximum and minimum elevation of the sun */
void setDawnDusk();
AltVsTimeUI *avtUI;
diff --git a/kstars/tools/astrocalc.h b/kstars/tools/astrocalc.h
index e4ec80f..5dd929f 100644
--- a/kstars/tools/astrocalc.h
+++ b/kstars/tools/astrocalc.h
@@ -41,7 +41,7 @@ public:
~AstroCalc();
- /**@returns suggested size of calculator window. */
+ /** @returns suggested size of calculator window. */
QSize sizeHint() const;
public slots:
/** Display calculator module or help text based on item selected.
diff --git a/kstars/tools/avtplotwidget.h b/kstars/tools/avtplotwidget.h
index 13fd2d2..120a5aa 100644
--- a/kstars/tools/avtplotwidget.h
+++ b/kstars/tools/avtplotwidget.h
@@ -22,7 +22,7 @@
#include <kplotwidget.h>
-/**@class AVTPlotWidget
+/** @class AVTPlotWidget
*@short An extension of the KPlotWidget for the AltVsTime tool.
*The biggest difference is that in addition to the plot objects, it
*draws the "ground" below Alt=0 and draws the sky light blue for day
diff --git a/kstars/tools/calendarwidget.h b/kstars/tools/calendarwidget.h
index 29dabba..7a35930 100644
--- a/kstars/tools/calendarwidget.h
+++ b/kstars/tools/calendarwidget.h
@@ -21,7 +21,7 @@
#include <QDate>
#include <kplotwidget.h>
-/**@class CalendarWidget
+/** @class CalendarWidget
*@short An extension of the KPlotWidget for the SkyCalendar tool.
*/
class CalendarWidget : public KPlotWidget
diff --git a/kstars/tools/flagmanager.h b/kstars/tools/flagmanager.h
index 1be7a87..9a91c42 100644
--- a/kstars/tools/flagmanager.h
+++ b/kstars/tools/flagmanager.h
@@ -32,7 +32,7 @@ class FlagManagerUI : public QFrame, public Ui::FlagManager
Q_OBJECT
public:
- /**@short Constructor
+ /** @short Constructor
*/
explicit FlagManagerUI( QWidget *parent );
};
diff --git a/kstars/tools/jmoontool.h b/kstars/tools/jmoontool.h
index 41504fe..79955c9 100644
--- a/kstars/tools/jmoontool.h
+++ b/kstars/tools/jmoontool.h
@@ -23,7 +23,7 @@ class KStars;
class QColor;
class KPlotWidget;
-/**@class JMoonTool
+/** @class JMoonTool
*@short Display the positions of Jupiter's moons as a function of time
*@version 1.0
*@author Jason Harris
diff --git a/kstars/tools/modcalcangdist.h b/kstars/tools/modcalcangdist.h
index 5c65d16..31293a7 100644
--- a/kstars/tools/modcalcangdist.h
+++ b/kstars/tools/modcalcangdist.h
@@ -48,7 +48,7 @@ private:
/** Process Lines **/
void processLines( QTextStream &istream );
- /**@returns a SkyPoint constructed from the coordinates in the RA and Dec dmsBoxes. */
+ /** @returns a SkyPoint constructed from the coordinates in the RA and Dec dmsBoxes. */
SkyPoint getCoords(dmsBox * rBox, dmsBox* dBox, bool *ok);
};
diff --git a/kstars/tools/modcalcvlsr.h b/kstars/tools/modcalcvlsr.h
index 6074d79..93ce879 100644
--- a/kstars/tools/modcalcvlsr.h
+++ b/kstars/tools/modcalcvlsr.h
@@ -62,7 +62,7 @@ private slots:
private:
- /**@returns a SkyPoint constructed from the coordinates in the
+ /** @returns a SkyPoint constructed from the coordinates in the
* RA and Dec dmsBoxes. */
SkyPoint skypoint();
diff --git a/kstars/tools/observinglist.h b/kstars/tools/observinglist.h
index 2d43f9e..98f8592 100644
--- a/kstars/tools/observinglist.h
+++ b/kstars/tools/observinglist.h
@@ -42,12 +42,12 @@ class ObservingListUI : public QFrame, public Ui::ObservingList {
Q_OBJECT
public:
- /**@short Cunstructor
+ /** @short Cunstructor
*/
ObservingListUI( QWidget *parent );
};
-/**@class ObservingList
+/** @class ObservingList
*Tool window for managing a custom list of objects. The window
*displays the Name, RA, Dec, mag, and type of each object in the list.
*
@@ -82,76 +82,76 @@ class ObservingList : public QDialog
Q_OBJECT
public:
- /**@short Constructor
+ /** @short Constructor
*/
ObservingList( KStars *_ks );
- /**@short Destuctor (empty)
+ /** @short Destuctor (empty)
*/
~ObservingList();
- /**@return true if the object is in the observing list
+ /** @return true if the object is in the observing list
*@p o pointer to the object to test.
*/
inline bool contains( const SkyObject *o ) { return m_WishList.contains( const_cast<SkyObject*>(o) ); }
- /**@return true if the window is in its default "large" state.
+ /** @return true if the window is in its default "large" state.
*/
bool isLarge() const { return bIsLarge; }
- /**@return reference to the current observing list
+ /** @return reference to the current observing list
*/
QList<SkyObject*>& obsList() { return m_WishList; }
- /**@return reference to the current observing list
+ /** @return reference to the current observing list
*/
QList<SkyObject*>& sessionList() { return m_SessionList; }
- /**@return pointer to the currently-selected object in the observing list
+ /** @return pointer to the currently-selected object in the observing list
*@note if more than one object is selected, this function returns 0.
*/
SkyObject *currentObject() const { return m_CurrentObject; }
- /**@short If the current list has unsaved changes, ask the user about saving it.
+ /** @short If the current list has unsaved changes, ask the user about saving it.
*@note also clears the list in preparation of opening a new one
*/
void saveCurrentList();
- /**@short Plot the SkyObject's Altitude vs Time in the AVTPlotWidget.
+ /** @short Plot the SkyObject's Altitude vs Time in the AVTPlotWidget.
*@p o pointer to the object to be plotted
*/
void plot( SkyObject *o );
- /**@short Return the altitude of the given SkyObject for the given hour.
+ /** @short Return the altitude of the given SkyObject for the given hour.
*@p p pointer to the SkyObject
*@p hour time at which altitude has to be found
*/
double findAltitude( SkyPoint *p, double hour=0);
- /**@short Return the list of downloaded images
+ /** @short Return the list of downloaded images
*/
QList<QString> imageList() { return ImageList; }
- /**@short Sets the image parameters for the current object
+ /** @short Sets the image parameters for the current object
*@p o The passed object for setting the parameters
*@p temp A flag to edit the name for temporary images
*/
void setCurrentImage( const SkyObject *o, bool temp = false );
- /**@short Save the user log text to a file.
+ /** @short Save the user log text to a file.
*@note the log is attached to the current object in obsList.
*/
void saveCurrentUserLog();
- /**@short decides on whether to enable the SaveImages button or not
+ /** @short decides on whether to enable the SaveImages button or not
*/
void setSaveImagesButton();
- /**@short This is the declaration of the event filter function
+ /** @short This is the declaration of the event filter function
* which is installed on the KImageFilePreview and the TabeView
*/
bool eventFilter( QObject *obj, QEvent *event );
- /**@short saves a thumbnail image for the details dialog
+ /** @short saves a thumbnail image for the details dialog
* from the downloaded image
*/
void saveThumbImage();
@@ -166,38 +166,38 @@ public:
KStarsDateTime dateTime() { return dt; }
- /**@short return the object with the name as the passed
+ /** @short return the object with the name as the passed
* QString from the Session List, return null otherwise
*/
SkyObject* findObjectByName( QString name );
- /**@short make a selection in the session view
+ /** @short make a selection in the session view
*/
void selectObject( const SkyObject *o );
- /**@short set the default image in the image preview.
+ /** @short set the default image in the image preview.
*/
void setDefaultImage();
- /**@short get object name. If star has no name, generate a name based on catalog number.
+ /** @short get object name. If star has no name, generate a name based on catalog number.
* @param translated set to true if the translated name is required.
*/
QString getObjectName(const SkyObject *o, bool translated=true);
public slots:
- /**@short add a new object to list
+ /** @short add a new object to list
*@p o pointer to the object to add to the list
*@p session flag toggle adding the object to the session list
*@p update flag to toggle the call of slotSaveList
*/
void slotAddObject( SkyObject *o=NULL, bool session=false, bool update=false );
- /**@short Remove skyobjects which are highlighted in the
+ /** @short Remove skyobjects which are highlighted in the
*observing list tool from the observing list.
*/
void slotRemoveSelectedObjects();
- /**@short Remove skyobject from the observing list.
+ /** @short Remove skyobject from the observing list.
*@p o pointer to the SkyObject to be removed.
*@p session flag to tell it whether to remove the object
*from the sessionlist or from the wishlist
@@ -206,131 +206,131 @@ public slots:
*/
void slotRemoveObject( SkyObject *o=NULL, bool session=false, bool update=false );
- /**@short center the selected object in the display
+ /** @short center the selected object in the display
*/
void slotCenterObject();
- /**@short slew the telescope to the selected object
+ /** @short slew the telescope to the selected object
*/
void slotSlewToObject();
- /**@short Show the details window for the selected object
+ /** @short Show the details window for the selected object
*/
void slotDetails();
- /**@short Show the Altitude vs Time for selecteld objects
+ /** @short Show the Altitude vs Time for selecteld objects
*/
void slotAVT();
- /**@short Open the WUT dialog
+ /** @short Open the WUT dialog
*/
void slotWUT();
- /**@short Add the object to the Session List
+ /** @short Add the object to the Session List
*/
void slotAddToSession();
- /**@short Open the Find Dialog
+ /** @short Open the Find Dialog
*/
void slotFind();
- /**@short Tasks needed when changing the selected object
+ /** @short Tasks needed when changing the selected object
*Save the user log of the previous selected object,
*find the new selected object in the obsList, and
*show the notes associated with the new selected object
*/
void slotNewSelection();
- /**@short load an observing list from disk.
+ /** @short load an observing list from disk.
*/
void slotOpenList();
- /**@short save the current observing list to disk.
+ /** @short save the current observing list to disk.
*/
void slotSaveList();
- /**@short Load the Wish list from disk.
+ /** @short Load the Wish list from disk.
*/
void slotLoadWishList();
- /**@short save the current observing session plan to disk, specify filename.
+ /** @short save the current observing session plan to disk, specify filename.
*/
void slotSaveSessionAs(bool nativeSave = true);
- /**@short save the current session
+ /** @short save the current session
*/
void slotSaveSession(bool nativeSave = true);
- /**@short construct a new observing list using the wizard.
+ /** @short construct a new observing list using the wizard.
*/
void slotWizard();
- /**@short toggle between the large and small window states
+ /** @short toggle between the large and small window states
*/
void slotToggleSize();
- /**@short toggle the setEnabled flags according to current view
+ /** @short toggle the setEnabled flags according to current view
*set the m_currentItem to NULL and clear selections
*@p index captures the integer value sent by the signal
*which is the currentIndex of the table
*/
void slotChangeTab(int index);
- /**@short Opens the Location dialog to set the GeoLocation
+ /** @short Opens the Location dialog to set the GeoLocation
*for the sessionlist.
*/
void slotLocation();
- /**@short Updates the tableviews for the new geolocation and date
+ /** @short Updates the tableviews for the new geolocation and date
*/
void slotUpdate();
- /**@short Takes the time from the QTimeEdit box and sets it as the
+ /** @short Takes the time from the QTimeEdit box and sets it as the
*time parameter in the tableview of the SessionList.
*/
void slotSetTime();
- /**@short Downloads the corresponding DSS or SDSS image from the web and
+ /** @short Downloads the corresponding DSS or SDSS image from the web and
*displays it
*/
void slotGetImage( bool _dss = false );
void slotSearchImage();
- /**@short Downloads the images of all the objects in the session list
+ /** @short Downloads the images of all the objects in the session list
*Note: This downloads the SDSS image, checks if the size is > default image
*and gets the DSS image if thats the case
*/
void slotSaveAllImages();
- /**@short saves the image syncronously from a given URL into a given file
+ /** @short saves the image syncronously from a given URL into a given file
*@p url the url from which the image has to be downloaded
*@p filename the file onto which the url has to be copied to
*NOTE: This is not a generic image saver, it is specific to the current object
*/
void saveImage( QUrl url , QString filename );
- /**@short saves the temporary image permanently
+ /** @short saves the temporary image permanently
*/
void slotSaveImage();
- /**@short Shows the image in a ImageViewer window.
+ /** @short Shows the image in a ImageViewer window.
*/
void slotImageViewer();
- /**@short Remove the current image
+ /** @short Remove the current image
*/
void slotDeleteCurrentImage();
- /**@short Removes all the save DSS/SDSS images from the disk.
+ /** @short Removes all the save DSS/SDSS images from the disk.
*/
void slotDeleteAllImages();
- /**@short download the DSS image and show it
+ /** @short download the DSS image and show it
*/
void slotDSS() { slotGetImage( true ); }
- /**@short Export a target list to the oal compliant format
+ /** @short Export a target list to the oal compliant format
*/
void slotOALExport();
diff --git a/kstars/tools/obslistwizard.h b/kstars/tools/obslistwizard.h
index ff149b7..f602455 100644
--- a/kstars/tools/obslistwizard.h
+++ b/kstars/tools/obslistwizard.h
@@ -31,7 +31,7 @@ public:
ObsListWizardUI( QWidget *p );
};
-/**@class ObsListWizard
+/** @class ObsListWizard
*@short Wizard for constructing observing lists
*@author Jason Harris
*/
@@ -39,12 +39,12 @@ class ObsListWizard : public QDialog
{
Q_OBJECT
public:
- /**@short Constructor */
+ /** @short Constructor */
ObsListWizard( QWidget *parent );
- /**@short Destructor */
+ /** @short Destructor */
~ObsListWizard();
- /**@return reference to QPtrList of objects selected by the wizard */
+ /** @return reference to QPtrList of objects selected by the wizard */
QList<SkyObject*>& obsList() { return ObsList; }
private slots:
@@ -60,7 +60,7 @@ private slots:
void slotParseRegion();
- /**@short Construct the observing list by applying the selected filters
+ /** @short Construct the observing list by applying the selected filters
*/
void slotObjectCountDirty();
void slotUpdateObjectCount();
@@ -69,7 +69,7 @@ private slots:
private:
void initialize();
void applyFilters( bool doBuildList );
- /**@return true if the object passes the filter region constraints, false otherwise.*/
+ /** @return true if the object passes the filter region constraints, false otherwise.*/
bool applyRegionFilter( SkyObject *o, bool doBuildList, bool doAdjustCount=true );
bool applyObservableFilter( SkyObject *o, bool doBuildList, bool doAdjustCount=true);
diff --git a/kstars/tools/planetviewer.h b/kstars/tools/planetviewer.h
index 02c05cb..5a4ce73 100644
--- a/kstars/tools/planetviewer.h
+++ b/kstars/tools/planetviewer.h
@@ -40,7 +40,7 @@ public:
PlanetViewerUI(QWidget *parent = 0 );
};
-/**@class PlanetViewer
+/** @class PlanetViewer
*@short Display an overhead view of the solar system
*@version 1.0
*@author Jason Harris
diff --git a/kstars/tools/scriptbuilder.h b/kstars/tools/scriptbuilder.h
index 63506f7..6fccc35 100644
--- a/kstars/tools/scriptbuilder.h
+++ b/kstars/tools/scriptbuilder.h
@@ -79,7 +79,7 @@ public:
explicit ScriptBuilderUI( QWidget *p );
};
-/**@class ScriptBuilder
+/** @class ScriptBuilder
*A GUI tool for building behavioral DBus scripts for KStars.
*@author Jason Harris
*@version 1.0
diff --git a/kstars/tools/wutdialog.h b/kstars/tools/wutdialog.h
index d80369b..792458f 100644
--- a/kstars/tools/wutdialog.h
+++ b/kstars/tools/wutdialog.h
@@ -35,7 +35,7 @@ public:
WUTDialogUI( QWidget *p=0 );
};
-/**@class WUTDialog
+/** @class WUTDialog
*What's up tonight dialog is a window which lists all skyobjects that will
*be visible during the next night.
*@author Thomas Kabelmann
@@ -44,37 +44,37 @@ public:
class WUTDialog : public QDialog {
Q_OBJECT
public:
- /**@short Constructor*/
+ /** @short Constructor*/
WUTDialog( QWidget *ks,
bool session = false,
GeoLocation *geo = KStarsData::Instance()->geo(),
KStarsDateTime lt = KStarsData::Instance()->lt() );
- /**@short Destructor*/
+ /** @short Destructor*/
~WUTDialog();
- /**@short Check visibility of object
+ /** @short Check visibility of object
*@p o the object to check
*@return true if visible
*/
bool checkVisibility(SkyObject *o);
public slots:
- /**@short Determine which objects are visible, and store them in
+ /** @short Determine which objects are visible, and store them in
*an array of lists, classified by object type
*/
void init();
private slots:
- /**@short Load the list of visible objects for selected object type.
+ /** @short Load the list of visible objects for selected object type.
*@p category the string describing the type of object
*/
void slotLoadList(const QString &category);
- /**@short display the rise/transit/set times for selected object
+ /** @short display the rise/transit/set times for selected object
*/
void slotDisplayObject(const QString &name);
- /**@short Apply user's choice of what part of the night should
+ /** @short Apply user's choice of what part of the night should
*be examined:
*@li 0: Evening only (sunset to midnight)
*@li 1: Morning only (midnight to sunrise)
@@ -82,29 +82,29 @@ private slots:
*/
void slotEveningMorning( int flag );
- /**@short Adjust the date for the WUT tool
+ /** @short Adjust the date for the WUT tool
*@note this does NOT affect the date of the sky map
*/
void slotChangeDate();
- /**@short Adjust the geographic location for the WUT tool
+ /** @short Adjust the geographic location for the WUT tool
*@note this does NOT affect the geographic location for the sky map
*/
void slotChangeLocation();
- /**@short open the detail dialog for the current object
+ /** @short open the detail dialog for the current object
*/
void slotDetails();
- /**@short center the display on the current object
+ /** @short center the display on the current object
*/
void slotCenter();
- /**@short Add the object to the observing list
+ /** @short Add the object to the observing list
*/
void slotObslist();
- /**@short Filters the objects displayed by Magnitude
+ /** @short Filters the objects displayed by Magnitude
*/
void slotChangeMagnitude();
@@ -113,9 +113,9 @@ private slots:
private:
QList<SkyObject*>& visibleObjects( const QString &category );
bool isCategoryInitialized( const QString &category );
- /**@short Initialize all SIGNAL/SLOT connections, used in constructor */
+ /** @short Initialize all SIGNAL/SLOT connections, used in constructor */
void makeConnections();
- /**@short Initialize catgory list, used in constructor */
+ /** @short Initialize catgory list, used in constructor */
void initCategories();
WUTDialogUI *WUT;
diff --git a/kstars/widgets/clicklabel.h b/kstars/widgets/clicklabel.h
index 0a6c0f1..2a3679b 100644
--- a/kstars/widgets/clicklabel.h
+++ b/kstars/widgets/clicklabel.h
@@ -21,7 +21,7 @@
#include <QLabel>
#include <QMouseEvent>
-/**@class ClickLabel is a QLabel with a clicked() signal.
+/** @class ClickLabel is a QLabel with a clicked() signal.
*@author Jason Harris
*@version 1.0
*/
diff --git a/kstars/widgets/dmsbox.h b/kstars/widgets/dmsbox.h
index a1a291a..f974ebc 100644
--- a/kstars/widgets/dmsbox.h
+++ b/kstars/widgets/dmsbox.h
@@ -23,7 +23,7 @@
#include "dms.h"
-/**@class dmsBox
+/** @class dmsBox
*A QLineEdit which is capable of displaying and parsing angle values
*flexibly and robustly. Angle values can be displayed and parsed as
*Degrees or Hours. When displaying a value, it uses a space-delimited
@@ -113,11 +113,11 @@ public:
*/
dms createDms(bool deg=true, bool *ok=0);
- /**@return a boolean indicating if object contains degrees or hours
+ /** @return a boolean indicating if object contains degrees or hours
*/
bool degType(void) const {return deg;}
- /**@short set the dmsBox to Degrees or Hours
+ /** @short set the dmsBox to Degrees or Hours
*@param t if true, the box expects angle values in degrees; otherwise
*it expects values in hours
*/
diff --git a/kstars/widgets/draglistbox.h b/kstars/widgets/draglistbox.h
index e4e9d1c..706ce78 100644
--- a/kstars/widgets/draglistbox.h
+++ b/kstars/widgets/draglistbox.h
@@ -26,7 +26,7 @@
class QDragEnterEvent;
-/**@class DragListBox
+/** @class DragListBox
*@short Extension of KListWidget that allows Drag-and-Drop
*with other DragListBoxes
*@author Jason Harris
@@ -36,11 +36,11 @@ class QDragEnterEvent;
class DragListBox : public QListWidget {
Q_OBJECT
public:
- /**@short Default constructor
+ /** @short Default constructor
*/
explicit DragListBox( QWidget *parent = 0, const char* name = 0 );
- /**@short Default destructor
+ /** @short Default destructor
*/
~DragListBox();
diff --git a/kstars/widgets/infoboxwidget.h b/kstars/widgets/infoboxwidget.h
index de16a24..317c64f 100644
--- a/kstars/widgets/infoboxwidget.h
+++ b/kstars/widgets/infoboxwidget.h
@@ -1,5 +1,5 @@
/***************************************************************************
- fovwidget.cpp - description
+ infoboxwidet.h - description
-------------------
begin : 20 Aug 2009
copyright : (C) 2009 by Khudyakov Alexey
@@ -28,6 +28,9 @@ class SkyPoint;
class SkyObject;
class InfoBoxWidget;
+/**
+ * @brief The InfoBoxes class is a collection of InfoBoxWidget objects that display a transparent box for display of text messages
+ */
class InfoBoxes : public QWidget
{
Q_OBJECT
@@ -44,7 +47,9 @@ private:
QList<InfoBoxWidget*> m_boxes;
};
-/** Small optianally transparent box for display of text messages. */
+/**
+* @brief The InfoBoxWidget class is a widget that displays a transparent box for display of text messages.
+*/
class InfoBoxWidget : public QWidget
{
Q_OBJECT
diff --git a/kstars/widgets/logedit.h b/kstars/widgets/logedit.h
index b47ed18..82610e8 100644
--- a/kstars/widgets/logedit.h
+++ b/kstars/widgets/logedit.h
@@ -21,7 +21,7 @@
#include <QTextEdit>
#include <QFocusEvent>
-/**@class LogEdit is a simple derivative of QTextEdit, that just adds a
+/** @class LogEdit is a simple derivative of QTextEdit, that just adds a
*focusOut() signal, emitted when the edit loses focus.
*@author Jason Harris
*@version 1.0
diff --git a/kstars/widgets/magnitudespinbox.h b/kstars/widgets/magnitudespinbox.h
index caddecf..a7613e0 100644
--- a/kstars/widgets/magnitudespinbox.h
+++ b/kstars/widgets/magnitudespinbox.h
@@ -18,7 +18,7 @@
* *
***************************************************************************/
-/**@class MagnitudeSpinBox
+/** @class MagnitudeSpinBox
*A special spinbox for entering magnitude values.
*This class now inherits QDoubleSpinBox instead of QSpinBox
*@short a custom spinbox for magnitude (float) values.
diff --git a/kstars/widgets/mapcanvas.h b/kstars/widgets/mapcanvas.h
index 1670d15..7bacf1d 100644
--- a/kstars/widgets/mapcanvas.h
+++ b/kstars/widgets/mapcanvas.h
@@ -23,7 +23,7 @@
#include <QMouseEvent>
#include <QPaintEvent>
-/**@class MapCanvas
+/** @class MapCanvas
*Used in LocationDialog for displaying a map of the Earth.
*In addition, cities in the database are drawn as grey or white dots.
*Also, the widget processes mouse clicks, to trim the list of
diff --git a/kstars/widgets/timespinbox.h b/kstars/widgets/timespinbox.h
index 2a58875..57478a8 100644
--- a/kstars/widgets/timespinbox.h
+++ b/kstars/widgets/timespinbox.h
@@ -22,7 +22,7 @@
class QStringList;
-/**@class TimeSpinBox
+/** @class TimeSpinBox
*Custom spinbox to handle selection of timestep values with variable units.
*@note this should only be used internally, embedded in a TimeStepBox widget.
*@author Jason Harris
@@ -51,7 +51,7 @@ public:
*/
virtual int valueFromText( const QString &text ) const;
- /**@return the current TimeStep setting */
+ /** @return the current TimeStep setting */
float timeScale() const;
void setDaysOnly( bool daysonly );
diff --git a/kstars/widgets/timestepbox.h b/kstars/widgets/timestepbox.h
index 04d796d..b204656 100644
--- a/kstars/widgets/timestepbox.h
+++ b/kstars/widgets/timestepbox.h
@@ -22,7 +22,7 @@
#include "timespinbox.h"
#include "timeunitbox.h"
-/**@class TimeStepBox
+/** @class TimeStepBox
*This composite widget consists of a TimeSpinBox (a QSpinBox), coupled with a
*TimeUnitBox (a second pair of up/down buttons).
*The second set of buttons makes larger steps through the 82 possible
@@ -39,10 +39,10 @@ public:
/**Destructor. (empty)*/
~TimeStepBox() {}
- /**@return a pointer to the child TimeSpinBox */
+ /** @return a pointer to the child TimeSpinBox */
TimeSpinBox* tsbox() const { return timeBox; }
- /**@return a pointer to the child TimeUnitBox*/
+ /** @return a pointer to the child TimeUnitBox*/
TimeUnitBox* unitbox() const { return unitBox; }
bool daysOnly() const { return DaysOnly; }
diff --git a/kstars/widgets/timeunitbox.h b/kstars/widgets/timeunitbox.h
index eec6e00..c8d912a 100644
--- a/kstars/widgets/timeunitbox.h
+++ b/kstars/widgets/timeunitbox.h
@@ -23,7 +23,7 @@
#define ALLUNITS 8
#define DAYUNITS 5
-/**@class TimeUnitBox
+/** @class TimeUnitBox
*A pair of buttons, arranged one above the other, labeled "+"/"-". These buttons
*are to be paired with the TimeSpinBox widget. Their function is to provide
*a way to cycle through the possible time steps using larger intervals than the up/down
@@ -49,10 +49,10 @@ public:
explicit TimeUnitBox(QWidget *parent=0, bool daysonly = false);
/**Destructor (empty)*/
~TimeUnitBox();
- /**@return the value of UnitStep for the current spinbox value() */
+ /** @return the value of UnitStep for the current spinbox value() */
int unitValue();
- /**@short the same as unitValue, except you can get the UnitStep for any value, not just the current one.
+ /** @short the same as unitValue, except you can get the UnitStep for any value, not just the current one.
*@return the value of UnitStep for the index value given as an argument.
*/
int getUnitValue( int );
@@ -61,7 +61,7 @@ public:
*@p value the new value
*/
void setValue( int value ) { Value = value; }
- /**@return the internal value describing the time-unit of the TimeSpinBox.
+ /** @return the internal value describing the time-unit of the TimeSpinBox.
*/
int value() const { return Value; }
@@ -72,10 +72,10 @@ public:
*/
void setMaximum( int maxValue ) { MaximumValue = maxValue; }
- /**@return the minimum value for the internal time-unit value
+ /** @return the minimum value for the internal time-unit value
*/
int minValue() const { return MinimumValue; }
- /**@return the maximum value for the internal time-unit value
+ /** @return the maximum value for the internal time-unit value
*/
int maxValue() const { return MaximumValue; }
More information about the Kstars-devel
mailing list