From 6ff29de7486afe9b6b58d0ea060100a7ba0b8c85 Mon Sep 17 00:00:00 2001 From: kh1 Date: Wed, 8 Oct 2014 16:39:17 +0200 Subject: Remove some unknown specifier. Fix documentation. Change-Id: I8c7fa0915c26d682260c507aa776d5cba1e543f5 Reviewed-by: Leena Miettinen --- src/libs/kdtools/kdupdaterupdatesourcesinfo.cpp | 131 ++++++++++++------------ 1 file changed, 64 insertions(+), 67 deletions(-) (limited to 'src/libs/kdtools') diff --git a/src/libs/kdtools/kdupdaterupdatesourcesinfo.cpp b/src/libs/kdtools/kdupdaterupdatesourcesinfo.cpp index ea54adcec..52a0bebe6 100644 --- a/src/libs/kdtools/kdupdaterupdatesourcesinfo.cpp +++ b/src/libs/kdtools/kdupdaterupdatesourcesinfo.cpp @@ -52,56 +52,46 @@ using namespace KDUpdater; /*! - \inmodule kdupdater - \class KDUpdater::UpdateSourcesInfo kdupdaterupdatesourcesinfo.h KDUpdaterUpdateSourcesInfo - \brief Provides access to information about the update sources set for the application. - - An update source is a repository that contains updates applicable for the application. - Applications can download updates from the update source and install them locally. - - Each application can have one or more update sources from which it can download updates. - Information about update source is stored in a file called UpdateSources.xml. This class helps - access and modify the UpdateSources.xml file. - - The complete file name of the UpdateSources.xml file can be specified via the \ref setFileName() - method. The class then parses the XML file and makes available information contained in - that XML file through an easy to use API. You can - - \li Get update sources information via the \ref updateSourceInfoCount() and \ref updateSourceInfo() - methods. - \li You can add/remove/change update source information via the \ref addUpdateSourceInfo(), - \ref removeUpdateSource(), \ref setUpdateSourceAt() methods. - - The class emits appropriate signals to inform listeners about changes in the update application. + \inmodule kdupdater + \class KDUpdater::UpdateSourcesInfo + \brief The UpdateSourcesInfo class provides access to information about the update sources set + for the application. + + An update source is a repository that contains updates applicable for the application. + Applications can download updates from the update source and install them locally. + + Each application can have one or more update sources from which it can download updates. + Information about update source is stored in a file called UpdateSources.xml. This class helps + access and modify the UpdateSources.xml file. + + The complete file name of the UpdateSources.xml file can be specified via the setFileName() + method. The class then parses the XML file and makes available information contained in + that XML file through an easy to use API. You can: + + \list + \li Get update sources information via the updateSourceInfoCount() and updateSourceInfo() + methods. + \li Add or remove update source information via the addUpdateSourceInfo() and + removeUpdateSourceInfo() methods. + \endlist + + The class emits appropriate signals to inform listeners about changes in the update application. */ -/*! \enum UpdateSourcesInfo::Error - * Error codes related to retrieving update sources - */ - -/*! \var UpdateSourcesInfo::Error UpdateSourcesInfo::NoError - * No error occurred - */ - -/*! \var UpdateSourcesInfo::Error UpdateSourcesInfo::NotYetReadError - * The package information was not parsed yet from the XML file - */ - -/*! \var UpdateSourcesInfo::Error UpdateSourcesInfo::CouldNotReadSourceFileError - * the specified update source file could not be read (does not exist or not readable) - */ - -/*! \var UpdateSourcesInfo::Error UpdateSourcesInfo::InvalidXmlError - * The source file contains invalid XML. - */ - -/*! \var UpdateSourcesInfo::Error UpdateSourcesInfo::InvalidContentError - * The source file contains valid XML, but does not match the expected format for source descriptions - */ - -/*! \var UpdateSourcesInfo::Error UpdateSourcesInfo::CouldNotSaveChangesError - * Changes made to the object could be saved back to the source file - */ +/*! + \enum UpdateSourcesInfo::Error + Error codes related to retrieving update sources. + + \value NoError No error occurred. + \value NotYetReadError The package information was not parsed yet from the XML file. + \value CouldNotReadSourceFileError The specified update source file could not be read + (does not exist or is not readable). + \value InvalidXmlError The source file contains invalid XML. + \value InvalidContentError The source file contains valid XML, but does not match the + expected format for source descriptions. + \value CouldNotSaveChangesError Changes made to the object could not be saved back to the + source file. +*/ struct UpdateSourceInfoPriorityHigherThan @@ -173,7 +163,7 @@ bool UpdateSourcesInfo::isValid() const } /*! - returns a human-readable description of the error + Returns a human-readable description of the last error that occurred. */ QString UpdateSourcesInfo::errorString() const { @@ -181,7 +171,8 @@ QString UpdateSourcesInfo::errorString() const } /*! - returns the last error + Returns the error that was found during the processing of the update sources XML file. If no + error was found, returns NoError. */ UpdateSourcesInfo::Error UpdateSourcesInfo::error() const { @@ -199,7 +190,7 @@ void UpdateSourcesInfo::setModified(bool modified) } /*! - Sets the complete file name of the UpdateSources.xml file. The function also issues a call + Sets the complete file name of the update sources XML file. The function also issues a call to refresh() to reload package information from the XML file. \sa KDUpdater::Application::setUpdateSourcesXMLFileName() @@ -214,7 +205,7 @@ void UpdateSourcesInfo::setFileName(const QString &fileName) } /*! - Returns the name of the UpdateSources.xml file that this class referred to. + Returns the name of the update sources XML file that this class referred to. */ QString UpdateSourcesInfo::fileName() const { @@ -230,8 +221,8 @@ int UpdateSourcesInfo::updateSourceInfoCount() const } /*! - Returns the update source info structure at \c index. If an invalid index is passed - the function returns a dummy constructor. + Returns the update source info structure at \a index. If an invalid index is passed, the + function returns a \l{default-constructed value}. */ UpdateSourceInfo UpdateSourcesInfo::updateSourceInfo(int index) const { @@ -243,7 +234,7 @@ UpdateSourceInfo UpdateSourcesInfo::updateSourceInfo(int index) const /*! Adds an update source info to this class. Upon successful addition, the class emits a - \ref updateSourceInfoAdded() signal. + updateSourceInfoAdded() signal. */ void UpdateSourcesInfo::addUpdateSourceInfo(const UpdateSourceInfo &info) { @@ -257,7 +248,7 @@ void UpdateSourcesInfo::addUpdateSourceInfo(const UpdateSourceInfo &info) /*! Removes an update source info from this class. Upon successful removal, the class emits a - \ref updateSourceInfoRemoved() signal. + updateSourceInfoRemoved() signal. */ void UpdateSourcesInfo::removeUpdateSourceInfo(const UpdateSourceInfo &info) { @@ -269,7 +260,7 @@ void UpdateSourcesInfo::removeUpdateSourceInfo(const UpdateSourceInfo &info) } /*! - This slot reloads the update source information from UpdateSources.xml. + Reloads the update source information from update sources XML file. */ void UpdateSourcesInfo::refresh() { @@ -405,32 +396,38 @@ void UpdateSourcesInfo::UpdateSourcesInfoData::addChildElement(QDomDocument &doc } /*! - \inmodule kdupdater - \struct KDUpdater::UpdateSourceInfo kdupdaterupdatesourcesinfo.h KDUpdaterUpdateSourcesInfo - \brief Describes a single update source + \inmodule kdupdater + \class KDUpdater::UpdateSourceInfo + \brief The UpdateSourceInfo class specifies a single update source. - An update source is a repository that contains updates applicable for the application. - This structure describes a single update source in terms of name, title, description, url and priority. + An update source is a repository that contains updates applicable for the application. + This structure describes a single update source in terms of name, title, description, + url, and priority. */ /*! - \var QString KDUpdater::UpdateSourceInfo::name + \variable UpdateSourceInfo::name + \brief The name of the update source. */ /*! - \var QString KDUpdater::UpdateSourceInfo::title + \variable UpdateSourceInfo::title + \brief The title of the update source. */ /*! - \var QString KDUpdater::UpdateSourceInfo::description + \variable UpdateSourceInfo::description + \brief The description of the update source. */ /*! - \var QUrl KDUpdater::UpdateSourceInfo::url + \variable UpdateSourceInfo::url + \brief The URL of the update source. */ /*! - \var QUrl KDUpdater::UpdateSourceInfo::priority + \variable UpdateSourceInfo::priority + \brief The priority of the update source. */ namespace KDUpdater { -- cgit v1.2.3