Add doxygen documentation for dcCanditateDc().

This commit is contained in:
2025-10-02 15:35:05 +02:00
parent 6f60265c74
commit d15593c7aa

View File

@@ -92,12 +92,27 @@ std::unique_ptr<QSettings> readSettings(QString const &optionalDirName) {
qCritical().noquote() << "read" << fileName << ":" << fi.absoluteFilePath() << "not found.";
}
} else {
qCritical().noquote() << "read" << fileName << ":" << internal::DEFAULT_INSTALL_DIR << "not found.";
qCritical().noquote() << internal::DEFAULT_INSTALL_DIR << "not found.";
}
return settings;
}
/*! \brief Find dc-binary to install.
*
* If rootDir is empty, and if dcDirectory is empty as well, use etc/dc in
* custome repository (e,.g. /opt/app/tools/atbupdate/customer_337/etc/dc).
* If dcDirectory is not empty, then use it.
* If rootDir is \b not empty,check if it alreay ends with "/etc/dc/". in this
* case, use rootDir as dcDir. Otherwise, if dcDirectory is empty, use rootDir/etc/dc
* (e,.g. /opt/app/tools/atbupdate/customer_337/etc/dc). If dcDirectory
* is not empty, use roorDir/dcDirectory.
* As last resort, try "/etc/dc".
*
* \param[in] dcDirectory directory of device controller binary. Maybe empty.
* \param[in] rootDir root directory for dcDirectory. Might be empty.
* \return name of the found candidate, or null if not found.
*/
std::unique_ptr<QString> dcCandidateToInstall(QString const &dcDirectory,
QString const &rootDir) {
std::unique_ptr<QString> dcCandidate{nullptr};