forked from qt-creator/qt-creator
Doc: Mark docs in Utils \internal if classes or functions not found
Change-Id: I3182534fefc51f573892d6f80f59ce5613f95fdc Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
@@ -196,6 +196,7 @@ static QStringList doSplitArgsWin(const QString &args, ProcessArgs::SplitError *
|
||||
}
|
||||
|
||||
/*!
|
||||
\internal
|
||||
Splits \a _args according to system shell word splitting and quoting rules.
|
||||
|
||||
\section1 Unix
|
||||
|
||||
@@ -209,7 +209,8 @@ private:
|
||||
};
|
||||
|
||||
/*!
|
||||
Creates thread
|
||||
\internal
|
||||
Creates a thread.
|
||||
*/
|
||||
FileInfoGatherer::FileInfoGatherer(QObject *parent)
|
||||
: QThread(parent)
|
||||
@@ -219,7 +220,8 @@ FileInfoGatherer::FileInfoGatherer(QObject *parent)
|
||||
}
|
||||
|
||||
/*!
|
||||
Destroys thread
|
||||
\internal
|
||||
Destroys a thread.
|
||||
*/
|
||||
FileInfoGatherer::~FileInfoGatherer()
|
||||
{
|
||||
@@ -265,6 +267,7 @@ QFileIconProvider *FileInfoGatherer::iconProvider() const
|
||||
}
|
||||
|
||||
/*!
|
||||
\internal
|
||||
Fetch extended information for all \a files in \a path
|
||||
|
||||
\sa updateFile(), update(), resolvedName()
|
||||
@@ -295,6 +298,7 @@ void FileInfoGatherer::fetchExtendedInformation(const QString &path, const QStri
|
||||
}
|
||||
|
||||
/*!
|
||||
\internal
|
||||
Fetch extended information for all \a filePath
|
||||
|
||||
\sa fetchExtendedInformation()
|
||||
@@ -1719,7 +1723,7 @@ QStringList FileSystemModel::mimeTypes() const
|
||||
\a indexes. The format used to describe the items corresponding to the
|
||||
indexes is obtained from the mimeTypes() function.
|
||||
|
||||
If the list of indexes is empty, \nullptr is returned rather than a
|
||||
If the list of indexes is empty, \c nullptr is returned rather than a
|
||||
serialized empty list.
|
||||
*/
|
||||
QMimeData *FileSystemModel::mimeData(const QModelIndexList &indexes) const
|
||||
@@ -1799,7 +1803,8 @@ QHash<int, QByteArray> FileSystemModel::roleNames() const
|
||||
}
|
||||
|
||||
/*!
|
||||
\enum FileSystemModel::Option
|
||||
\internal
|
||||
\enum Utils::FileSystemModel::Option
|
||||
\since 5.14
|
||||
|
||||
\value DontWatchForChanges Do not add file watchers to the paths.
|
||||
@@ -1847,6 +1852,7 @@ bool FileSystemModel::testOption(Option option) const
|
||||
}
|
||||
|
||||
/*!
|
||||
\internal
|
||||
\property FileSystemModel::options
|
||||
\brief the various options that affect the model
|
||||
\since 5.14
|
||||
@@ -2121,6 +2127,7 @@ QDir::Filters FileSystemModel::filter() const
|
||||
}
|
||||
|
||||
/*!
|
||||
\internal
|
||||
\property FileSystemModel::resolveSymlinks
|
||||
\brief Whether the directory model should resolve symbolic links
|
||||
|
||||
@@ -2146,6 +2153,7 @@ bool FileSystemModel::resolveSymlinks() const
|
||||
}
|
||||
|
||||
/*!
|
||||
\internal
|
||||
\property FileSystemModel::readOnly
|
||||
\brief Whether the directory model allows writing to the file system
|
||||
|
||||
@@ -2165,6 +2173,7 @@ bool FileSystemModel::isReadOnly() const
|
||||
}
|
||||
|
||||
/*!
|
||||
\internal
|
||||
\property FileSystemModel::nameFilterDisables
|
||||
\brief Whether files that don't pass the name filter are hidden or disabled
|
||||
|
||||
|
||||
@@ -28,6 +28,7 @@ Q_LOGGING_CATEGORY(fileIconProvider, "qtc.core.fileiconprovider", QtWarningMsg)
|
||||
|
||||
/*!
|
||||
\class Utils::FileIconProvider
|
||||
\internal
|
||||
\inmodule QtCreator
|
||||
\brief Provides functions for registering custom overlay icons for system
|
||||
icons.
|
||||
@@ -220,6 +221,7 @@ QIcon FileIconProviderImplementation::icon(const FilePath &filePath) const
|
||||
}
|
||||
|
||||
/*!
|
||||
\internal
|
||||
Returns the icon associated with the file suffix in \a filePath. If there is none,
|
||||
the default icon of the operating system is returned.
|
||||
*/
|
||||
@@ -230,14 +232,16 @@ QIcon icon(const FilePath &filePath)
|
||||
}
|
||||
|
||||
/*!
|
||||
* \overload
|
||||
*/
|
||||
\internal
|
||||
\overload
|
||||
*/
|
||||
QIcon icon(QFileIconProvider::IconType type)
|
||||
{
|
||||
return instance()->icon(type);
|
||||
}
|
||||
|
||||
/*!
|
||||
\internal
|
||||
Creates a pixmap with \a baseIcon and lays \a overlayIcon over it.
|
||||
*/
|
||||
QPixmap overlayIcon(const QPixmap &baseIcon, const QIcon &overlayIcon)
|
||||
@@ -249,6 +253,7 @@ QPixmap overlayIcon(const QPixmap &baseIcon, const QIcon &overlayIcon)
|
||||
}
|
||||
|
||||
/*!
|
||||
\internal
|
||||
Creates a pixmap with \a baseIcon at \a size and \a overlay.
|
||||
*/
|
||||
QPixmap overlayIcon(QStyle::StandardPixmap baseIcon, const QIcon &overlay, const QSize &size)
|
||||
@@ -257,6 +262,7 @@ QPixmap overlayIcon(QStyle::StandardPixmap baseIcon, const QIcon &overlay, const
|
||||
}
|
||||
|
||||
/*!
|
||||
\internal
|
||||
Registers an icon at \a path for a given \a suffix, overlaying the system
|
||||
file icon.
|
||||
*/
|
||||
@@ -266,6 +272,7 @@ void registerIconOverlayForSuffix(const QString &path, const QString &suffix)
|
||||
}
|
||||
|
||||
/*!
|
||||
\internal
|
||||
Registers \a icon for all the suffixes of a the mime type \a mimeType,
|
||||
overlaying the system file icon.
|
||||
*/
|
||||
@@ -275,7 +282,8 @@ void registerIconOverlayForMimeType(const QIcon &icon, const QString &mimeType)
|
||||
}
|
||||
|
||||
/*!
|
||||
* \overload
|
||||
\internal
|
||||
\overload
|
||||
*/
|
||||
void registerIconOverlayForMimeType(const QString &path, const QString &mimeType)
|
||||
{
|
||||
|
||||
@@ -205,6 +205,7 @@ LayoutItem::~LayoutItem() = default;
|
||||
|
||||
/*!
|
||||
\fn template <class T> LayoutItem(const T &t)
|
||||
\internal
|
||||
|
||||
Constructs a layout item proxy for \a t.
|
||||
|
||||
@@ -489,6 +490,7 @@ void doAddWidget(LayoutBuilder &builder, QWidget *widget)
|
||||
|
||||
/*!
|
||||
\class Layouting::LayoutBuilder
|
||||
\internal
|
||||
\inmodule QtCreator
|
||||
|
||||
\brief The LayoutBuilder class provides a convenient way to fill \c QFormLayout
|
||||
@@ -505,6 +507,7 @@ void doAddWidget(LayoutBuilder &builder, QWidget *widget)
|
||||
LayoutBuilder::LayoutBuilder() = default;
|
||||
|
||||
/*!
|
||||
\internal
|
||||
Destructs a layout builder.
|
||||
*/
|
||||
LayoutBuilder::~LayoutBuilder() = default;
|
||||
@@ -521,7 +524,7 @@ void LayoutBuilder::addItems(const LayoutItems &items)
|
||||
}
|
||||
|
||||
/*!
|
||||
This starts a new row containing \a items. The row can be further extended by
|
||||
Starts a new row containing \a items. The row can be further extended by
|
||||
other items using \c addItem() or \c addItems().
|
||||
|
||||
\sa addItem(), addItems()
|
||||
|
||||
@@ -72,6 +72,7 @@ private:
|
||||
};
|
||||
|
||||
/*!
|
||||
\internal
|
||||
Connect to all of the models signals. Whenever anything happens
|
||||
recheck everything.
|
||||
*/
|
||||
@@ -135,6 +136,7 @@ void ModelTest::runAllTests()
|
||||
}
|
||||
|
||||
/*!
|
||||
\internal
|
||||
nonDestructiveBasicTest tries to call a number of the basic functions (not all)
|
||||
to make sure the model doesn't outright segfault, testing the functions that makes sense.
|
||||
*/
|
||||
@@ -173,6 +175,7 @@ void ModelTest::nonDestructiveBasicTest()
|
||||
}
|
||||
|
||||
/*!
|
||||
\internal
|
||||
Tests model's implementation of QAbstractItemModel::rowCount() and hasChildren()
|
||||
|
||||
Models that are dynamically populated are not as fully tested here.
|
||||
@@ -200,6 +203,7 @@ void ModelTest::rowCount()
|
||||
}
|
||||
|
||||
/*!
|
||||
\internal
|
||||
Tests model's implementation of QAbstractItemModel::columnCount() and hasChildren()
|
||||
*/
|
||||
void ModelTest::columnCount()
|
||||
@@ -218,6 +222,7 @@ void ModelTest::columnCount()
|
||||
}
|
||||
|
||||
/*!
|
||||
\internal
|
||||
Tests model's implementation of QAbstractItemModel::hasIndex()
|
||||
*/
|
||||
void ModelTest::hasIndex()
|
||||
@@ -242,6 +247,7 @@ void ModelTest::hasIndex()
|
||||
}
|
||||
|
||||
/*!
|
||||
\internal
|
||||
Tests model's implementation of QAbstractItemModel::index()
|
||||
*/
|
||||
void ModelTest::index()
|
||||
@@ -274,6 +280,7 @@ void ModelTest::index()
|
||||
}
|
||||
|
||||
/*!
|
||||
\internal
|
||||
Tests model's implementation of QAbstractItemModel::parent()
|
||||
*/
|
||||
void ModelTest::parent()
|
||||
@@ -322,6 +329,7 @@ void ModelTest::parent()
|
||||
}
|
||||
|
||||
/*!
|
||||
\internal
|
||||
Called from the parent() test.
|
||||
|
||||
A model that returns an index of parent X should also return X when asking
|
||||
@@ -430,6 +438,7 @@ void ModelTest::checkChildren(const QModelIndex &parent, int currentDepth)
|
||||
}
|
||||
|
||||
/*!
|
||||
\internal
|
||||
Tests model's implementation of QAbstractItemModel::data()
|
||||
*/
|
||||
void ModelTest::data()
|
||||
@@ -494,6 +503,7 @@ void ModelTest::data()
|
||||
}
|
||||
|
||||
/*!
|
||||
\internal
|
||||
Store what is about to be inserted to make sure it actually happens
|
||||
|
||||
\sa rowsInserted()
|
||||
@@ -510,6 +520,7 @@ void ModelTest::rowsAboutToBeInserted(const QModelIndex &parent, int start, int
|
||||
}
|
||||
|
||||
/*!
|
||||
\internal
|
||||
Confirm that what was said was going to happen actually did
|
||||
|
||||
\sa rowsAboutToBeInserted()
|
||||
@@ -547,6 +558,7 @@ void ModelTest::layoutChanged()
|
||||
}
|
||||
|
||||
/*!
|
||||
\internal
|
||||
Store what is about to be inserted to make sure it actually happens
|
||||
|
||||
\sa rowsRemoved()
|
||||
@@ -562,6 +574,7 @@ void ModelTest::rowsAboutToBeRemoved(const QModelIndex &parent, int start, int e
|
||||
}
|
||||
|
||||
/*!
|
||||
\internal
|
||||
Confirm that what was said was going to happen actually did
|
||||
|
||||
\sa rowsAboutToBeRemoved()
|
||||
|
||||
Reference in New Issue
Block a user