summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2023-11-28 14:45:30 +0000
committerTopi Reiniƶ <topi.reinio@qt.io>2023-12-08 10:56:56 +0000
commit1fda6109c0c302d3b2d2ccb05802391e421e64d6 (patch)
tree3f72e68893834a8d6cdb8b3282683cab996aa0af /src
parent8e70a8a7287f773d9d181d2d39363328e5c0a4de (diff)
Doc: Fix documentation build configuration
The custom qmake documentation build target did not correctly locate private include paths for Qt modules. Fix this by replacing dashes with underscores (e.g. qtcore-private -> qtcore_private) before querying the paths. Remove duplicate entry for qtcore-private (it's already added at top level). In ifw.qdocconf, fix relative additional include paths. Remove all non-existent paths from the configuration. Use the correct URL for the online documentation. Remove the now-obsolete custom module header, and let QDoc build an artificial one based on 'headerdirs'. In passing, fix minor issues in the documentation sources. Change-Id: I5cdbd64307448014fa8b73a70378627fdb89b942 Reviewed-by: Katja Marttila <katja.marttila@qt.io>
Diffstat (limited to 'src')
-rw-r--r--src/libs/installer/genericdatacache.cpp2
-rw-r--r--src/libs/installer/libarchivewrapper_p.cpp2
-rw-r--r--src/libs/installer/packagesource.cpp2
-rw-r--r--src/libs/installer/sysinfo_win.cpp4
-rw-r--r--src/libs/installer/systeminfo.cpp4
5 files changed, 8 insertions, 6 deletions
diff --git a/src/libs/installer/genericdatacache.cpp b/src/libs/installer/genericdatacache.cpp
index 73d34b94a..a1e31ccfe 100644
--- a/src/libs/installer/genericdatacache.cpp
+++ b/src/libs/installer/genericdatacache.cpp
@@ -428,7 +428,7 @@ T *GenericDataCache<T>::itemByPath(const QString &path) const
The cache takes ownership of the object pointed by \a item. The contents of the
item are copied or moved to the cache with a subdirectory name that matches the checksum
- of the item. The \c mode decides how the contents of the item are registered, either by
+ of the item. The \a mode decides how the contents of the item are registered, either by
copying or moving.
Returns \c true on success or \c false if the item could not be registered.
diff --git a/src/libs/installer/libarchivewrapper_p.cpp b/src/libs/installer/libarchivewrapper_p.cpp
index 233ff816e..b4325243d 100644
--- a/src/libs/installer/libarchivewrapper_p.cpp
+++ b/src/libs/installer/libarchivewrapper_p.cpp
@@ -41,12 +41,14 @@ namespace QInstaller {
*/
/*!
+ \internal
\fn QInstaller::LibArchiveWrapperPrivate::dataBlockRequested()
Emitted when the server process has requested another data block.
*/
/*!
+ \internal
\fn QInstaller::LibArchiveWrapperPrivate::remoteWorkerFinished()
Emitted when the server process has finished extracting an archive.
diff --git a/src/libs/installer/packagesource.cpp b/src/libs/installer/packagesource.cpp
index 5bc61f8e4..0f87e0def 100644
--- a/src/libs/installer/packagesource.cpp
+++ b/src/libs/installer/packagesource.cpp
@@ -50,7 +50,7 @@ namespace QInstaller {
*/
/*!
- \fn QInstaller::PackageSource::PackageSource(const QUrl &u, int p)
+ \fn QInstaller::PackageSource::PackageSource(const QUrl &u, int p, bool pl)
Constructs a package source info object. The object's url is set to \a u, while the priority
is set to \a p.
diff --git a/src/libs/installer/sysinfo_win.cpp b/src/libs/installer/sysinfo_win.cpp
index e74eb1d4e..e5df8e35f 100644
--- a/src/libs/installer/sysinfo_win.cpp
+++ b/src/libs/installer/sysinfo_win.cpp
@@ -64,7 +64,7 @@ VolumeInfo updateVolumeSizeInformation(const VolumeInfo &info)
return update;
}
-/*!
+/*
Returns a list of volume info objects that are mounted as network drive shares.
*/
QList<VolumeInfo> networkVolumeInfosFromMountPoints()
@@ -95,7 +95,7 @@ QList<VolumeInfo> networkVolumeInfosFromMountPoints()
return volumes;
}
-/*!
+/*
Returns a list of volume info objects based on the given \a volumeGUID. The function also solves mounted
volume folder paths. It does not return any network drive shares.
*/
diff --git a/src/libs/installer/systeminfo.cpp b/src/libs/installer/systeminfo.cpp
index 0b9b00500..3859382b4 100644
--- a/src/libs/installer/systeminfo.cpp
+++ b/src/libs/installer/systeminfo.cpp
@@ -63,7 +63,7 @@ SystemInfo::SystemInfo(QObject *parent) : QObject(parent)
OS running on a 64-bit CPU is usually unable to determine whether the CPU is actually capable
of running 64-bit programs.
- \sa QSysInfo::currentCpuArchitecture() \sa buildCpuArchitecture()
+ \sa QSysInfo::currentCpuArchitecture() buildCpuArchitecture()
*/
QString SystemInfo::currentCpuArchitecture() const
{
@@ -86,7 +86,7 @@ QString SystemInfo::currentCpuArchitecture() const
there's an emulation layer or if the CPU supports multiple architectures (like x86-64
processors supporting i386 applications). To detect that, use \c installer.currentCpuArchitecture()
- \sa QSysInfo::buildCpuArchitecture() \sa currentCpuArchitecture()
+ \sa QSysInfo::buildCpuArchitecture() currentCpuArchitecture()
*/
QString SystemInfo::buildCpuArchitecture() const
{