From 17f3e4fb3a2e560131527f91ca64944667223bd9 Mon Sep 17 00:00:00 2001 From: Arttu Tarkiainen Date: Wed, 16 Sep 2020 18:14:44 +0300 Subject: 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 --- src/libs/installer/lib7z_facade.cpp | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'src/libs/installer/lib7z_facade.cpp') diff --git a/src/libs/installer/lib7z_facade.cpp b/src/libs/installer/lib7z_facade.cpp index c321052e3..3e6b10259 100644 --- a/src/libs/installer/lib7z_facade.cpp +++ b/src/libs/installer/lib7z_facade.cpp @@ -832,7 +832,7 @@ STDMETHODIMP ExtractCallback::SetOperationResult(Int32 /*resultEOperationResult* /*! \fn virtual Lib7z::ExtractCallback::setCompleted(quint64 completed, quint64 total) - Returns completed. Always returns true. \a completed and \a total are unused. + Always returns \c true. \c completed and \c total are unused. */ @@ -951,9 +951,9 @@ static QString createTmp7z() } /*! - Creates an archive using the given file device \a archive. \a sourcePaths can contain one or - more files, one or more directories or a combination of files and folders. The \c * wildcard - is supported also. The value of \a level specifies the compression ratio, the default is set + Creates an archive using the given file device \a archive. \a sources can contain one or + more files, one or more directories or a combination of files and folders. Also, \c * wildcard + is supported. The value of \a level specifies the compression ratio, the default is set to \c 5 (Normal compression). The \a callback can be used to get information about the archive creation process. If no \a callback is given, an empty implementation is used. @@ -979,8 +979,8 @@ void INSTALLER_EXPORT createArchive(QFileDevice *archive, const QStringList &sou } /*! - Creates an archive with the given filename \a archive. \a sourcePaths can contain one or more - files, one or more directories or a combination of files and folders. Also the \c * wildcard + Creates an archive with the given filename \a archive. \a sources can contain one or more + files, one or more directories or a combination of files and folders. Also, \c * wildcard is supported. To be able to use the function during an elevated installation, set \a mode to \c TmpFile::Yes. The value of \a level specifies the compression ratio, the default is set to \c 5 (Normal compression). The \a callback can be used to get information about the archive -- cgit v1.2.3