Skip to content

Commit 3c19765

Browse files
Olf0nephros
andauthored
[patchmanager.cpp] Reintroduce two dummy methods for documentation … (#452)
* [patchmanager.cpp] Reintroduce two dummy methods for documentation purposes only Reference: The core aspect of the whole back and forth in PR #451: #451 * [patchmanager.cpp] Be concise documenting options / switches / output * [patchmanager.cpp] Rectify indention and trailing spaces * [patchmanager.cpp] Document the consequence "which breaks the CI runs" --------- Co-authored-by: Peter G <[email protected]>
1 parent 500f5c7 commit 3c19765

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

src/qml/patchmanager.cpp

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1013,6 +1013,43 @@ bool PatchManagerTranslator::installTranslator(const QString &patch)
10131013
return true;
10141014
}
10151015

1016+
/*
1017+
The only purpose of the following two dummy methods is to document
1018+
their corresponding definitions in /src/qml/patchmanager.h,
1019+
because qdoc warns about undocumented classes and functions, but
1020+
does not allow for qdoc source documentation in header files.
1021+
*/
1022+
1023+
/*! void PatchManager::activation(const QString & patch, const QString & version);
1024+
Defined in line 160 (section "public slots:") of /src/qml/patchmanager.h
1025+
Used in line 295 of /src/qml/AboutPage.qml
1026+
\warning probably dead code, need to investigate
1027+
probably \internal, using \a patch and \a version
1028+
*/
1029+
void PatchManager::activation(const QString & patch, const QString & version)
1030+
{
1031+
/*
1032+
Requires dummy operations, utilising patch and version; otherwise
1033+
a [-Werror=unused-parameter] is emitted, turned into an error
1034+
by the global CONFIG_WERROR=y switch, which breaks the CI runs.
1035+
*/
1036+
}
1037+
1038+
/*! void PatchManager::easterReceived(const QString & easterText);
1039+
Defined in line 188 (section "signals:") of /src/qml/patchmanager.h
1040+
Used in line 2514 of /src/bin/patchmanager-daemon/patchmanagerobject.cpp
1041+
\warning probably dead code, need to investigate
1042+
probably \internal, using \a easterText
1043+
*/
1044+
void PatchManager::easterReceived(const QString & easterText)
1045+
{
1046+
/*
1047+
Requires a dummy operation, utilising easterText; otherwise
1048+
a [-Werror=unused-parameter] is emitted, turned into an error
1049+
by the global CONFIG_WERROR=y switch, which breaks the CI runs.
1050+
*/
1051+
}
1052+
10161053
/*!
10171054
Returns \e true if \a filename exists, \e false otherwise.
10181055
\sa https://doc.qt.io/qt-5/qfile.html#exists-1

0 commit comments

Comments
 (0)