diff options
| author | Arttu Tarkiainen <arttu.tarkiainen@qt.io> | 2020-09-16 18:14:44 +0300 |
|---|---|---|
| committer | Arttu Tarkiainen <arttu.tarkiainen@qt.io> | 2020-09-21 06:44:32 +0000 |
| commit | 17f3e4fb3a2e560131527f91ca64944667223bd9 (patch) | |
| tree | 483eb0e64b5cf4adcab969bedaa88dba3d2b83ce /src/libs/installer/repository.cpp | |
| parent | 7b16ab246d5c8241f08c0ffa3a87c9803ec4aa50 (diff) | |
Doc: Reduce the amount of documentation warnings
Miscellaneous fixes to missing function documentation, undocumented
parameters, namespace scope etc. As 5.12.7 based qdoc gives a lot
more warnings about code missing documentation, mark undocumented
implementation details with \internal command. Also some spelling
fixes to related parts of documentation.
Task-number: QTIFW-1483
Change-Id: Ibf5d1e5098713acbd152c5b61ea4f46cc11feb4b
Reviewed-by: Katja Marttila <katja.marttila@qt.io>
Diffstat (limited to 'src/libs/installer/repository.cpp')
| -rw-r--r-- | src/libs/installer/repository.cpp | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/src/libs/installer/repository.cpp b/src/libs/installer/repository.cpp index 47e985eb2..3957ce5aa 100644 --- a/src/libs/installer/repository.cpp +++ b/src/libs/installer/repository.cpp @@ -64,7 +64,7 @@ Repository::Repository(const Repository &other) /*! Constructs a new repository by setting its address to \a url - and its default and \a compressed states. + and \a isDefault and \a compressed states. */ Repository::Repository(const QUrl &url, bool isDefault, bool compressed) : m_url(url) @@ -144,7 +144,8 @@ bool Repository::isEnabled() const } /*! - Sets this repository to \n enabled state and thus to use this repository for information retrieval or not. + Sets this repository to \a enabled state. If \a enabled is \c true, + the repository is used for information retrieval. */ void Repository::setEnabled(bool enabled) { @@ -276,6 +277,9 @@ void Repository::registerMetaType() qRegisterMetaTypeStreamOperators<Repository>("Repository"); } +/*! + \internal +*/ QDataStream &operator>>(QDataStream &istream, Repository &repository) { QByteArray url, username, password, displayname, compressed; @@ -288,6 +292,9 @@ QDataStream &operator>>(QDataStream &istream, Repository &repository) return istream; } +/*! + \internal +*/ QDataStream &operator<<(QDataStream &ostream, const Repository &repository) { return ostream << repository.m_url.toEncoded().toBase64() << repository.m_default << repository.m_enabled |