forked from qt-creator/qt-creator
Fix developer documentation warnings
With qdoc from Qt 6.8 Change-Id: I8884a53e81e28e2f801f9a76bf9cc082cb831678 Reviewed-by: hjk <hjk@qt.io>
This commit is contained in:
@@ -30,7 +30,7 @@
|
||||
*/
|
||||
|
||||
/*!
|
||||
\enum IPlugin::ShutdownFlag
|
||||
\enum ExtensionSystem::IPlugin::ShutdownFlag
|
||||
|
||||
This enum type holds whether the plugin is shut down synchronously or
|
||||
asynchronously.
|
||||
|
||||
@@ -629,19 +629,19 @@ private:
|
||||
*/
|
||||
|
||||
/*!
|
||||
\typealias CustomTask::Task
|
||||
\typealias Tasking::CustomTask::Task
|
||||
|
||||
Type alias for the task type associated with the custom task's \c Adapter.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\typealias CustomTask::Deleter
|
||||
\typealias Tasking::CustomTask::Deleter
|
||||
|
||||
Type alias for the task's type deleter associated with the custom task's \c Adapter.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\typealias CustomTask::TaskSetupHandler
|
||||
\typealias Tasking::CustomTask::TaskSetupHandler
|
||||
|
||||
Type alias for \c std::function<SetupResult(Task &)>.
|
||||
|
||||
@@ -676,7 +676,7 @@ private:
|
||||
*/
|
||||
|
||||
/*!
|
||||
\typealias CustomTask::TaskDoneHandler
|
||||
\typealias Tasking::CustomTask::TaskDoneHandler
|
||||
|
||||
Type alias for \c std::function<DoneResult(const Task &, DoneWith)> or DoneResult.
|
||||
|
||||
@@ -865,7 +865,7 @@ private:
|
||||
*/
|
||||
|
||||
/*!
|
||||
\variable sequential
|
||||
\variable Tasking::sequential
|
||||
A convenient global group's element describing the sequential execution mode.
|
||||
|
||||
This is the default execution mode of the Group element.
|
||||
@@ -880,7 +880,7 @@ private:
|
||||
*/
|
||||
|
||||
/*!
|
||||
\variable parallel
|
||||
\variable Tasking::parallel
|
||||
A convenient global group's element describing the parallel execution mode.
|
||||
|
||||
All the direct child tasks of a group are started after the group is started,
|
||||
@@ -891,7 +891,7 @@ private:
|
||||
*/
|
||||
|
||||
/*!
|
||||
\variable parallelIdealThreadCountLimit
|
||||
\variable Tasking::parallelIdealThreadCountLimit
|
||||
A convenient global group's element describing the parallel execution mode with a limited
|
||||
number of tasks running simultanously. The limit is equal to the ideal number of threads
|
||||
excluding the calling thread.
|
||||
@@ -905,39 +905,39 @@ private:
|
||||
*/
|
||||
|
||||
/*!
|
||||
\variable stopOnError
|
||||
\variable Tasking::stopOnError
|
||||
A convenient global group's element describing the StopOnError workflow policy.
|
||||
|
||||
This is the default workflow policy of the Group element.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\variable continueOnError
|
||||
\variable Tasking::continueOnError
|
||||
A convenient global group's element describing the ContinueOnError workflow policy.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\variable stopOnSuccess
|
||||
\variable Tasking::stopOnSuccess
|
||||
A convenient global group's element describing the StopOnSuccess workflow policy.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\variable continueOnSuccess
|
||||
\variable Tasking::continueOnSuccess
|
||||
A convenient global group's element describing the ContinueOnSuccess workflow policy.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\variable stopOnSuccessOrError
|
||||
\variable Tasking::stopOnSuccessOrError
|
||||
A convenient global group's element describing the StopOnSuccessOrError workflow policy.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\variable finishAllAndSuccess
|
||||
\variable Tasking::finishAllAndSuccess
|
||||
A convenient global group's element describing the FinishAllAndSuccess workflow policy.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\variable finishAllAndError
|
||||
\variable Tasking::finishAllAndError
|
||||
A convenient global group's element describing the FinishAllAndError workflow policy.
|
||||
*/
|
||||
|
||||
@@ -1028,7 +1028,7 @@ private:
|
||||
*/
|
||||
|
||||
/*!
|
||||
\typealias GroupItem::GroupSetupHandler
|
||||
\typealias Tasking::GroupItem::GroupSetupHandler
|
||||
|
||||
Type alias for \c std::function<SetupResult()>.
|
||||
|
||||
@@ -1058,7 +1058,7 @@ private:
|
||||
*/
|
||||
|
||||
/*!
|
||||
\typealias GroupItem::GroupDoneHandler
|
||||
\typealias Tasking::GroupItem::GroupDoneHandler
|
||||
|
||||
Type alias for \c std::function<DoneResult(DoneWith)> or DoneResult.
|
||||
|
||||
@@ -3407,13 +3407,13 @@ void TimeoutTaskAdapter::start()
|
||||
}
|
||||
|
||||
/*!
|
||||
\typealias TaskTreeTask
|
||||
\typealias Tasking::TaskTreeTask
|
||||
|
||||
Type alias for the CustomTask, to be used inside recipes, associated with the TaskTree task.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\typealias TimeoutTask
|
||||
\typealias Tasking::TimeoutTask
|
||||
|
||||
Type alias for the CustomTask, to be used inside recipes, associated with the
|
||||
\c std::chrono::milliseconds type. \c std::chrono::milliseconds is used to set up the
|
||||
|
||||
@@ -93,12 +93,12 @@ private:
|
||||
*/
|
||||
|
||||
/*!
|
||||
\typedef QrcParser::Ptr
|
||||
\typedef Utils::QrcParser::Ptr
|
||||
Represents pointers.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\typedef QrcParser::ConstPtr
|
||||
\typedef Utils::QrcParser::ConstPtr
|
||||
Represents constant pointers.
|
||||
*/
|
||||
|
||||
|
||||
@@ -216,9 +216,9 @@ TextFileFormat::ReadResult readTextFile(const FilePath &filePath, const QTextCod
|
||||
Reads a text file from \a filePath into a list of strings, \a plainTextList
|
||||
using \a defaultCodec and text file format \a format.
|
||||
|
||||
Returns whether decoding was possible without errors. If errors occur,
|
||||
returns an error message, \a errorString and a sample error,
|
||||
\a decodingErrorSample.
|
||||
Returns whether decoding was possible without errors. If an errors occur
|
||||
\a errorString is set to the error message, and \a decodingErrorSample is
|
||||
set to a snippet that failed to decode.
|
||||
*/
|
||||
|
||||
TextFileFormat::ReadResult
|
||||
@@ -239,8 +239,9 @@ TextFileFormat::ReadResult
|
||||
Reads a text file from \a filePath into a string, \a plainText using
|
||||
\a defaultCodec and text file format \a format.
|
||||
|
||||
Returns whether decoding was possible without errors.
|
||||
|
||||
Returns whether decoding was possible without errors. If an errors occur
|
||||
\a errorString is set to the error message, and \a decodingErrorSample is
|
||||
set to a snippet that failed to decode.
|
||||
*/
|
||||
|
||||
TextFileFormat::ReadResult
|
||||
|
||||
@@ -129,7 +129,7 @@ using namespace Internal;
|
||||
* name.
|
||||
*/
|
||||
|
||||
/*! \enum ReadOnlyFilesDialog::ReadOnlyResult
|
||||
/*! \enum Core::ReadOnlyFilesDialog::ReadOnlyResult
|
||||
This enum holds the operations that are allowed to make the file writable.
|
||||
|
||||
\value RO_Cancel
|
||||
|
||||
@@ -208,7 +208,7 @@ void EditorManagerPlaceHolder::showEvent(QShowEvent *)
|
||||
*/
|
||||
|
||||
/*!
|
||||
\enum EditorManager::OpenEditorFlag
|
||||
\enum Core::EditorManager::OpenEditorFlag
|
||||
|
||||
This enum specifies settings for opening a file in an editor.
|
||||
|
||||
|
||||
@@ -72,7 +72,7 @@
|
||||
*/
|
||||
|
||||
/*!
|
||||
\enum IDocument::OpenResult
|
||||
\enum Core::IDocument::OpenResult
|
||||
|
||||
The OpenResult enum describes whether a file was successfully opened.
|
||||
|
||||
@@ -87,13 +87,13 @@
|
||||
*/
|
||||
|
||||
/*!
|
||||
\enum IDocument::ReloadSetting
|
||||
\enum Core::IDocument::ReloadSetting
|
||||
|
||||
\internal
|
||||
*/
|
||||
|
||||
/*!
|
||||
\enum IDocument::ChangeTrigger
|
||||
\enum Core::IDocument::ChangeTrigger
|
||||
|
||||
The ChangeTrigger enum describes whether a file was changed from \QC
|
||||
internally or from the outside.
|
||||
@@ -107,7 +107,7 @@
|
||||
*/
|
||||
|
||||
/*!
|
||||
\enum IDocument::ChangeType
|
||||
\enum Core::IDocument::ChangeType
|
||||
|
||||
The ChangeType enum describes the way in which the file changed.
|
||||
|
||||
@@ -121,7 +121,7 @@
|
||||
*/
|
||||
|
||||
/*!
|
||||
\enum IDocument::ReloadFlag
|
||||
\enum Core::IDocument::ReloadFlag
|
||||
|
||||
The ReloadFlag enum describes if a file should be reloaded from disk.
|
||||
|
||||
|
||||
@@ -63,7 +63,7 @@ public:
|
||||
*/
|
||||
|
||||
/*!
|
||||
\property IMode::enabled
|
||||
\property Core::IMode::enabled
|
||||
|
||||
This property holds whether the mode is enabled.
|
||||
|
||||
@@ -71,7 +71,7 @@ public:
|
||||
*/
|
||||
|
||||
/*!
|
||||
\property IMode::displayName
|
||||
\property Core::IMode::displayName
|
||||
|
||||
This property holds the display name of the mode.
|
||||
|
||||
@@ -79,7 +79,7 @@ public:
|
||||
*/
|
||||
|
||||
/*!
|
||||
\property IMode::icon
|
||||
\property Core::IMode::icon
|
||||
|
||||
This property holds the icon of the mode.
|
||||
|
||||
@@ -88,7 +88,7 @@ public:
|
||||
*/
|
||||
|
||||
/*!
|
||||
\property IMode::priority
|
||||
\property Core::IMode::priority
|
||||
|
||||
This property holds the priority of the mode.
|
||||
|
||||
@@ -99,13 +99,13 @@ public:
|
||||
*/
|
||||
|
||||
/*!
|
||||
\property IMode::id
|
||||
\property Core::IMode::id
|
||||
|
||||
This property holds the ID of the mode.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\property IMode::menu
|
||||
\property Core::IMode::menu
|
||||
|
||||
This property holds the mode's menu.
|
||||
|
||||
|
||||
@@ -17,7 +17,7 @@ namespace Core {
|
||||
*/
|
||||
|
||||
/*!
|
||||
\enum IOutputPane::Flag
|
||||
\enum Core::IOutputPane::Flag
|
||||
|
||||
This enum type controls the behavior of the output pane when it is requested to show itself.
|
||||
|
||||
|
||||
@@ -884,7 +884,8 @@ void ILocatorFilter::setConfigurable(bool configurable)
|
||||
|
||||
/*!
|
||||
Shows the standard configuration dialog with options for the prefix string
|
||||
and for isIncludedByDefault(). The \a additionalWidget is added at the top.
|
||||
and for isIncludedByDefault(). \a parent is used as the dialog's parent.
|
||||
The \a additionalWidget is added at the top.
|
||||
Ownership of \a additionalWidget stays with the caller, but its parent is
|
||||
reset to \c nullptr.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user