From ca6dac1b663a7cefcb576692384d69ac0b85b0a5 Mon Sep 17 00:00:00 2001
From: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
Date: Fri, 29 Jan 2021 12:39:18 +0200
Subject: Doc: Misc fixes for Lib7z namespace documentation

We are still missing quite a bit documentation for this namespace. Add
documentation for symbols that could be easily documented and mark the
rest as internal, at least for the time being. Otherwise the generated
html docs contain stub sections for these symbols.

Change-Id: I471873c8da5050f9fb3a4f033da71dcb0aff7b3c
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
---
 src/libs/installer/lib7z_facade.cpp | 76 ++++++++++++++++++++++++++++++++++---
 1 file changed, 71 insertions(+), 5 deletions(-)

(limited to 'src/libs')

diff --git a/src/libs/installer/lib7z_facade.cpp b/src/libs/installer/lib7z_facade.cpp
index e7dbf4c6c..591973c34 100644
--- a/src/libs/installer/lib7z_facade.cpp
+++ b/src/libs/installer/lib7z_facade.cpp
@@ -115,6 +115,36 @@ void registerCodecByteSwap();
 
 namespace Lib7z {
 
+/*!
+    \inmodule Lib7z
+    \class Lib7z::File
+    \internal
+*/
+
+/*!
+    \inmodule Lib7z
+    \class Lib7z::UpdateCallback
+    \internal
+*/
+
+/*!
+    \inmodule Lib7z
+    \class Lib7z::SevenZipException
+    \brief The SevenZipException provides a class for lib7z exceptions.
+*/
+
+/*!
+    \fn explicit Lib7z::SevenZipException::SevenZipException(const QString &msg)
+
+    Constructs an instance of SevenZipException with error message \a msg.
+*/
+
+/*!
+    \fn explicit Lib7z::SevenZipException::SevenZipException(const char *msg)
+
+    Constructs an instance of SevenZipException with error message \a msg.
+*/
+
 /*!
     \inmodule Lib7z
     \class Lib7z::PercentPrinter
@@ -606,15 +636,24 @@ QVector<File> listArchive(QFileDevice *archive)
     return QVector<File>(); // never reached
 }
 
+/*!
+    \inmodule Lib7z
+    \class Lib7z::ExtractCallback
+    \brief Provides a callback for archive extraction.
+*/
 
-// -- ExtractCallback
-
+/*!
+    \internal
+*/
 STDMETHODIMP ExtractCallback::SetTotal(UInt64 t)
 {
     total = t;
     return S_OK;
 }
 
+/*!
+    \internal
+*/
 STDMETHODIMP ExtractCallback::SetCompleted(const UInt64 *c)
 {
     completed = *c;
@@ -623,8 +662,12 @@ STDMETHODIMP ExtractCallback::SetCompleted(const UInt64 *c)
     return S_OK;
 }
 
-// this method will be called by CFolderOutStream::OpenFile to stream via
-// CDecoder::CodeSpec extracted content to an output stream.
+/*!
+    \internal
+
+    This method will be called by CFolderOutStream::OpenFile to stream via
+    CDecoder::CodeSpec extracted content to an output stream.
+*/
 STDMETHODIMP ExtractCallback::GetStream(UInt32 index, ISequentialOutStream **outStream, Int32 /*askExtractMode*/)
 {
     *outStream = nullptr;
@@ -685,11 +728,17 @@ STDMETHODIMP ExtractCallback::GetStream(UInt32 index, ISequentialOutStream **out
     return S_OK;
 }
 
+/*!
+    \internal
+*/
 STDMETHODIMP ExtractCallback::PrepareOperation(Int32 /*askExtractMode*/)
 {
     return S_OK;
 }
 
+/*!
+    \internal
+*/
 STDMETHODIMP ExtractCallback::SetOperationResult(Int32 /*resultEOperationResult*/)
 {
     if (targetDir.isEmpty())
@@ -838,9 +887,26 @@ STDMETHODIMP ExtractCallback::SetOperationResult(Int32 /*resultEOperationResult*
 /*!
     \fn virtual Lib7z::ExtractCallback::setCompleted(quint64 completed, quint64 total)
 
-    Always returns \c true. \c completed and \c total are unused.
+    Always returns \c true.
 */
 
+/*!
+    \fn ULONG Lib7z::ExtractCallback::AddRef()
+
+    \internal
+*/
+
+/*!
+    \fn LONG Lib7z::ExtractCallback::QueryInterface(const GUID &iid, void **outObject)
+
+    \internal
+*/
+
+/*!
+    \fn ULONG Lib7z::ExtractCallback::Release()
+
+    \internal
+*/
 
 // -- UpdateCallback
 
-- 
cgit v1.2.3