[frameworks/karchive] src: Documentation fixes
Nicolas Fella <[email protected]>
| Newsgroups | gmane.comp.kde.cvs |
|---|---|
| Message-ID | <[email protected]> |
Git commit 7b6541c7de538a3988d895a89ae6b5e914178f93 by Nicolas Fella.
Committed on 21/07/2026 at 12:19.
Pushed by nicolasfella into branch 'master'.
Documentation fixes
M +3 -3 src/k7zip.cpp
M +1 -1 src/kar.h
M +2 -0 src/kcompressiondevice.h
M +1 -1 src/krcc.cpp
M +1 -1 src/ktar.cpp
https://invent.kde.org/frameworks/karchive/-/commit/7b6541c7de538a3988d895a89ae6b5e914178f93
diff --git a/src/k7zip.cpp b/src/k7zip.cpp
index b1de7db..d5057db 100644
--- a/src/k7zip.cpp
+++ b/src/k7zip.cpp
@@ -172,7 +172,7 @@ static const quint64 k_AES = 0x06F10701;
static const quint64 k_ZSTD = 0x4F71101;
// static const quint64 k_BROTLI = 0x4F71102;
-/*!
+/*
* A K7ZipFileEntry represents a file in a 7zip archive.
*/
class K7ZipFileEntry : public KArchiveFile
@@ -191,13 +191,13 @@ public:
~K7ZipFileEntry() override;
- /*!
+ /*
* Returns the content of this file.
* Call data() with care (only once per file), this data isn't cached.
*/
[[nodiscard]] QByteArray data() const override;
- /*!
+ /*
* This method returns QIODevice (internal class: KLimitedIODevice)
* on top of the underlying QIODevice. This is obviously for reading only.
*
diff --git a/src/kar.h b/src/kar.h
index 347cb39..e6347d0 100644
--- a/src/kar.h
+++ b/src/kar.h
@@ -10,7 +10,7 @@
/*!
* \class KAr
- * \module KArchive
+ * \inmodule KArchive
*
* KAr is a class for reading archives in ar format. Writing
* is not supported. Reading archives that contain files bigger than
diff --git a/src/kcompressiondevice.h b/src/kcompressiondevice.h
index 810e421..25e1358 100644
--- a/src/kcompressiondevice.h
+++ b/src/kcompressiondevice.h
@@ -22,6 +22,8 @@ class KFilterBase;
* \class KCompressionDevice
* \inmodule KArchive
*
+ * \brief QIODevice for reading compressed data.
+ *
* A class for reading and writing compressed data onto a device
* (e.g. file, but other usages are possible, like a buffer or a socket).
*
diff --git a/src/krcc.cpp b/src/krcc.cpp
index 5956884..028af72 100644
--- a/src/krcc.cpp
+++ b/src/krcc.cpp
@@ -27,7 +27,7 @@ public:
QString m_prefix; // '/' + uuid
};
-/*!
+/*
* A KRccFileEntry represents a file in a rcc archive.
*/
class KRccFileEntry : public KArchiveFile
diff --git a/src/ktar.cpp b/src/ktar.cpp
index 9fedf22..1935593 100644
--- a/src/ktar.cpp
+++ b/src/ktar.cpp
@@ -658,7 +658,7 @@ bool KTar::doFinishWriting(qint64 size)
return true;
}
-/*!* Some help from the tar sources
+/* Some help from the tar sources
struct posix_header
{ byte offset
char name[100]; * 0 * 0x0