summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJasem Mutlaq <mutlaqja@ikarustech.com>2016-08-21 16:47:15 (GMT)
committerJasem Mutlaq <mutlaqja@ikarustech.com>2016-08-21 16:47:15 (GMT)
commit120139a2f418628aac9b4a2635d5f9d4cd9bfc90 (patch)
tree676dda2ed6b2a245417626d43ac7936d4fe9cd8a
parent82c89591f42091033bbaf4a667145b81737bb53f (diff)
Fix misspelling and API doc fixes
-rw-r--r--kstars/ekos/align.cpp8
-rw-r--r--kstars/ekos/align.h23
-rw-r--r--kstars/ekos/capture.h11
-rw-r--r--kstars/ekos/focus.h44
-rw-r--r--kstars/org.kde.kstars.Ekos.Align.xml2
5 files changed, 53 insertions, 35 deletions
diff --git a/kstars/ekos/align.cpp b/kstars/ekos/align.cpp
index c496488..3f84a14 100644
--- a/kstars/ekos/align.cpp
+++ b/kstars/ekos/align.cpp
@@ -649,7 +649,7 @@ bool Align::captureAndSolve()
currentCCD->setUploadMode(ISD::CCD::UPLOAD_LOCAL);
// For solver remote we need to start solver BEFORE capture
- startSovling(QString());
+ startSolving(QString());
}
else
{
@@ -764,7 +764,7 @@ void Align::newFITS(IBLOB *bp)
previewImage->updateFrame();
}
- startSovling(fitsFileName);
+ startSolving(fitsFileName);
}
}
@@ -786,7 +786,7 @@ void Align::setGOTOMode(int mode)
}
}
-void Align::startSovling(const QString &filename, bool isGenerated)
+void Align::startSolving(const QString &filename, bool isGenerated)
{
QStringList solverArgs;
double ra,dec;
@@ -1688,7 +1688,7 @@ void Align::loadAndSlew(QString fileURL)
stopB->setEnabled(true);
pi->startAnimation();
- startSovling(fileURL, false);
+ startSolving(fileURL, false);
}
void Align::setExposure(double value)
diff --git a/kstars/ekos/align.h b/kstars/ekos/align.h
index ea3b496..f0d0327 100644
--- a/kstars/ekos/align.h
+++ b/kstars/ekos/align.h
@@ -77,7 +77,7 @@ public:
* @param isGenerated Set to true if filename is generated from a CCD capture operation. If the file is loaded from any storage or network media, pass false.
* @return Returns true if device if found and selected, false otherwise.
*/
- Q_SCRIPTABLE Q_NOREPLY void startSovling(const QString &filename, bool isGenerated=true);
+ Q_SCRIPTABLE Q_NOREPLY void startSolving(const QString &filename, bool isGenerated=true);
/** DBUS interface function.
* Select Goto Mode of Solver. The solver mode is the action the solver performs upon successful solving.
@@ -230,6 +230,10 @@ public slots:
*/
void newFITS(IBLOB *bp);
+ /** \addtogroup AlignDBusInterface
+ * @{
+ */
+
/** DBUS interface function.
* Aborts the solving operation.
*/
@@ -247,6 +251,15 @@ public slots:
*/
Q_SCRIPTABLE bool captureAndSolve();
+ /** DBUS interface function.
+ * Loads an image (FITS or JPG/TIFF) and solve its coordinates, then it slews to the solved coordinates and an image is captured and solved to ensure
+ * the telescope is pointing to the same coordinates of the image.
+ * @param fileURL URL to the image to solve
+ */
+ Q_SCRIPTABLE Q_NOREPLY void loadAndSlew(QString fileURL = QString());
+
+ /** @}*/
+
/**
* @brief Solver finished successfully, process the data and execute the required actions depending on the mode.
* @param orientation Orientation of image in degrees (East of North)
@@ -272,14 +285,6 @@ public slots:
*/
void setWCS(bool enable);
-
- /** DBUS interface function.
- * Loads an image (FITS or JPG/TIFF) and solve its coordinates, then it slews to the solved coordinates and an image is captured and solved to ensure
- * the telescope is pointing to the same coordinates of the image.
- * @param fileURL URL to the image to solve
- */
- Q_SCRIPTABLE Q_NOREPLY void loadAndSlew(QString fileURL = QString());
-
void setLockedFilter(ISD::GDInterface *filter, int lockedPosition);
void updateFocusStatus(Ekos::FocusState state);
diff --git a/kstars/ekos/capture.h b/kstars/ekos/capture.h
index 9d87c26..c52da35 100644
--- a/kstars/ekos/capture.h
+++ b/kstars/ekos/capture.h
@@ -190,12 +190,12 @@ public:
/** DBUS interface function.
* @return Returns time left in seconds until active job is estimated to be complete.
*/
- int getActiveJobRemainingTime();
+ Q_SCRIPTABLE int getActiveJobRemainingTime();
/** DBUS interface function.
* @return Returns overall time left in seconds until all jobs are estimated to be complete
*/
- int getOverallRemainingTime();
+ Q_SCRIPTABLE int getOverallRemainingTime();
/** DBUS interface function.
* @param id job number. Job IDs start from 0 to N-1.
@@ -257,8 +257,13 @@ public:
/* Capture */
void updateSequencePrefix( const QString &newPrefix, const QString &dir);
+
public slots:
+ /** \addtogroup CaptureDBusInterface
+ * @{
+ */
+
/* Capture */
/** DBUS interface function.
* Starts the sequence queue capture procedure sequentially by starting all jobs that are either Idle or Aborted in order.
@@ -270,6 +275,8 @@ public slots:
*/
Q_SCRIPTABLE Q_NOREPLY void abort();
+ /** @}*/
+
/**
* @brief captureOne Capture one preview image
*/
diff --git a/kstars/ekos/focus.h b/kstars/ekos/focus.h
index b14357b..ca4323a 100644
--- a/kstars/ekos/focus.h
+++ b/kstars/ekos/focus.h
@@ -172,6 +172,10 @@ public:
public slots:
+ /** \addtogroup FocusDBusInterface
+ * @{
+ */
+
/* Focus */
/** DBUS interface function.
* Start the autofocus operation.
@@ -188,6 +192,25 @@ public slots:
*/
Q_SCRIPTABLE Q_NOREPLY void capture();
+ /** DBUS interface function.
+ * Focus inward
+ * @param ms If set, focus inward for ms ticks (Absolute Focuser), or ms milliseconds (Relative Focuser). If not set, it will use the value specified in the options.
+ */
+ Q_SCRIPTABLE Q_NOREPLY void FocusIn(int ms=-1);
+
+ /** DBUS interface function.
+ * Focus outward
+ * @param ms If set, focus outward for ms ticks (Absolute Focuser), or ms milliseconds (Relative Focuser). If not set, it will use the value specified in the options.
+ */
+ Q_SCRIPTABLE Q_NOREPLY void FocusOut(int ms=-1);
+
+ /** DBUS interface function.
+ * resetFocusFrame Resets the focus frame to the CCDs original dimensions before any subframing was done.
+ */
+ Q_SCRIPTABLE Q_NOREPLY void resetFocusFrame();
+
+ /** @}*/
+
/**
* @brief startFraming Begins continious capture of the CCD and calculates HFR every frame.
*/
@@ -228,19 +251,7 @@ public slots:
/**
* @brief clearDataPoints Remove all data points from HFR plots
*/
- void clearDataPoints();
-
- /** DBUS interface function.
- * Focus inward
- * @param ms If set, focus inward for ms ticks (Absolute Focuser), or ms milliseconds (Relative Focuser). If not set, it will use the value specified in the options.
- */
- Q_SCRIPTABLE Q_NOREPLY void FocusIn(int ms=-1);
-
- /** DBUS interface function.
- * Focus outward
- * @param ms If set, focus outward for ms ticks (Absolute Focuser), or ms milliseconds (Relative Focuser). If not set, it will use the value specified in the options.
- */
- Q_SCRIPTABLE Q_NOREPLY void FocusOut(int ms=-1);
+ void clearDataPoints();
/**
* @brief focusStarSelected The user selected a focus star, save its coordinates and subframe it if subframing is enabled.
@@ -271,12 +282,7 @@ public slots:
* @brief updateFocusStatus Upon completion of the focusing process, set its status (fail or pass) and reset focus process to clean state.
* @param status If true, the focus process finished successfully. Otherwise, it failed.
*/
- void setAutoFocusResult(bool status);
-
- /** DBUS interface function.
- * resetFocusFrame Resets the focus frame to the CCDs original dimensions before any subframing was done.
- */
- Q_SCRIPTABLE Q_NOREPLY void resetFocusFrame();
+ void setAutoFocusResult(bool status);
/**
* @brief filterChangeWarning Warn the user it is not a good idea to apply image filter in the filter process as they can skew the HFR calculations.
diff --git a/kstars/org.kde.kstars.Ekos.Align.xml b/kstars/org.kde.kstars.Ekos.Align.xml
index 30fa1c0..46c9535 100644
--- a/kstars/org.kde.kstars.Ekos.Align.xml
+++ b/kstars/org.kde.kstars.Ekos.Align.xml
@@ -19,7 +19,7 @@
<arg type="b" direction="out"/>
<arg name="device" type="s" direction="in"/>
</method>
- <method name="startSovling">
+ <method name="startSolving">
<arg name="filename" type="s" direction="in"/>
<arg name="isGenerated" type="b" direction="in"/>
<annotation name="org.freedesktop.DBus.Method.NoReply" value="true"/>