Doc: Fix QDoc warnings in Core plugin dialogs classes

- Fix IOptionsPage class docs
- Mark PromptOverwriteDialog and ReadOnlyFilesDialog

Fixes: QTCREATORBUG-23608
Change-Id: I6a646f0bd68230a7c5f80bd748bda20729f23b74
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
Leena Miettinen
2020-02-14 16:55:29 +01:00
parent 086b4eef07
commit d06eee5218
4 changed files with 68 additions and 31 deletions

View File

@@ -133,16 +133,32 @@ ReadOnlyFilesDialogPrivate::~ReadOnlyFilesDialogPrivate()
using namespace Internal;
/*!
* \class ReadOnlyFilesDialog
* \class Core::ReadOnlyFilesDialog
* \inmodule QtCreator
* \internal
* \brief The ReadOnlyFilesDialog class implements a dialog to show a set of
* files that are classified as not writable.
*
* Automatically checks which operations are allowed to make the file writable. These operations
* are Make Writable which tries to set the file permissions in the file system,
* Open With Version Control System if the open operation is allowed by the version control system
* and Save As which is used to save the changes to a document in another file.
* are \c MakeWritable (RO_MakeWritable), which tries to set the file permissions in the file system,
* \c OpenWithVCS (RO_OpenVCS) if the open operation is allowed by the version control system,
* and \c SaveAs (RO_SaveAs), which is used to save the changes to a document under another file
* name.
*/
/*! \enum ReadOnlyFilesDialog::ReadOnlyResult
This enum holds the operations that are allowed to make the file writable.
\value RO_Cancel
Cancels the operation.
\value RO_OpenVCS
Opens the file under control of the version control system.
\value RO_MakeWritable
Sets the file permissions in the file system.
\value RO_SaveAs
Saves changes to a document under another file name.
*/
ReadOnlyFilesDialog::ReadOnlyFilesDialog(const Utils::FilePaths &filePaths, QWidget *parent)
: QDialog(parent)
, d(new ReadOnlyFilesDialogPrivate(this))