Merge pull request #465 from nephros/452plus

[Doc] Remove/Improve build-breaking "Dummy" method docs

Author: nephros

src/qml/patchmanager.cpp

@@ -614,7 +614,10 @@ void PatchManager::doVote(const QString &patch, int action)
     putSettingsSync(QStringLiteral("votes/%1").arg(patch), action);
 }
 
-/*! \internal lets not spoil the fun (or the eggs!). */
+/*!
+   \internal
+   lets not spoil the fun (or the eggs!).
+*/
 void PatchManager::checkEaster()
 {
     qDebug() << Q_FUNC_INFO;
@@ -1019,36 +1022,23 @@ bool PatchManagerTranslator::installTranslator(const QString &patch)
     because qdoc warns about undocumented classes and functions, but
     does not allow for qdoc source documentation in header files.
 */
-    
-/*! void PatchManager::activation(const QString & patch, const QString & version);
-    Defined in line 160 (section "public slots:") of /src/qml/patchmanager.h
-    Used in line 295 of /src/qml/AboutPage.qml
-    \warning probably dead code, need to investigate
-    probably \internal, using \a patch and \a version
+
+/*! \fn void PatchManager::activation(const QString & patch, const QString & version);
+    \internal
+    using \a patch and \a version
+    \warning This seems to be dead code as nothing seems to attach to this slot, need to investigate removal
 */
-void PatchManager::activation(const QString & patch, const QString & version)
-{
-    /* 
-        Requires dummy operations, utilising patch and version; otherwise
-        a [-Werror=unused-parameter] is emitted, turned into an error
-        by the global CONFIG_WERROR=y switch, which breaks the CI runs.
-    */
-}
 
-/*! void PatchManager::easterReceived(const QString & easterText);
-    Defined in line 188 (section "signals:") of /src/qml/patchmanager.h
-    Used in line 2514 of /src/bin/patchmanager-daemon/patchmanagerobject.cpp
-    \warning probably dead code, need to investigate
-    probably \internal, using \a easterText
+/*! \fn void PatchManager::easterReceived(const QString &easterText);
+    \internal
+
+    This signal is emitted when checkEaster() has determined there is an easter
+    egg to display, and contains \a easterText as a string parameter.
+
+    Used in AboutPage to display an easter egg.
+
+    \sa AboutPage
 */
-void PatchManager::easterReceived(const QString & easterText)
-{
-    /* 
-        Requires a dummy operation, utilising easterText; otherwise
-        a [-Werror=unused-parameter] is emitted, turned into an error
-        by the global CONFIG_WERROR=y switch, which breaks the CI runs.
-    */
-}
 
 /*!
     Returns \e true if \a filename exists, \e false otherwise.