diff options
author | Topi Reinio <topi.reinio@qt.io> | 2018-04-10 12:10:23 +0200 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@qt.io> | 2018-04-10 11:24:54 +0000 |
commit | c66dc18b37bf50d8b773089d161bccd286d4cd3a (patch) | |
tree | fd2f5d1e83abc999750cbcbcc3e5e4e5436ceb59 | |
parent | 03923b27ebf982629d2dd936b8597964cc464bfe (diff) | |
download | qttools-c66dc18b37bf50d8b773089d161bccd286d4cd3a.tar.gz |
Doc: Fix documentation warnings for Qt Designer
Add missing documentation for QDesignerFormWindowInterface,
fix \fn commands and missing namespace specifiers.
Change-Id: I3481781d30760768d4b79d8ea889c1c17b251f67
Reviewed-by: Martin Smith <martin.smith@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
4 files changed, 26 insertions, 4 deletions
diff --git a/src/designer/src/lib/extension/extension.cpp b/src/designer/src/lib/extension/extension.cpp index 6534be2d4..f5d4059d1 100644 --- a/src/designer/src/lib/extension/extension.cpp +++ b/src/designer/src/lib/extension/extension.cpp @@ -126,7 +126,7 @@ QT_BEGIN_NAMESPACE */ /*! - \fn T qt_extension(QAbstractExtensionManager* manager, QObject *object) + \fn template <class T> T qt_extension(QAbstractExtensionManager* manager, QObject *object) \relates QExtensionManager @@ -167,7 +167,7 @@ QT_BEGIN_NAMESPACE class definition for \a ExtensionName, in the associated header file. - \sa Q_DECLARE_INTERFACE() + \sa {Q_DECLARE_INTERFACE}{Q_DECLARE_INTERFACE()} */ QT_END_NAMESPACE diff --git a/src/designer/src/lib/sdk/abstractformwindow.cpp b/src/designer/src/lib/sdk/abstractformwindow.cpp index 946dab842..062b1687a 100644 --- a/src/designer/src/lib/sdk/abstractformwindow.cpp +++ b/src/designer/src/lib/sdk/abstractformwindow.cpp @@ -821,6 +821,22 @@ void QDesignerFormWindowInterface::activateResourceFilePaths(const QStringList & */ /*! + \fn ResourceFileSaveMode QDesignerFormWindowInterface::resourceFileSaveMode() const + + Returns the resource file save mode behavior. + + \sa setResourceFileSaveMode() +*/ + +/*! + \fn void QDesignerFormWindowInterface::setResourceFileSaveMode(ResourceFileSaveMode behavior) + + Sets the resource file save mode \a behavior. + + \sa resourceFileSaveMode() +*/ + +/*! \fn void QDesignerFormWindowInterface::widgetManaged(QWidget *widget) This signal is emitted whenever a widget on the form becomes managed. diff --git a/src/designer/src/lib/sdk/abstractformwindowmanager.cpp b/src/designer/src/lib/sdk/abstractformwindowmanager.cpp index 7206d3b79..9160a974e 100644 --- a/src/designer/src/lib/sdk/abstractformwindowmanager.cpp +++ b/src/designer/src/lib/sdk/abstractformwindowmanager.cpp @@ -434,6 +434,12 @@ QAction *QDesignerFormWindowManagerInterface::actionSimplifyLayout() const */ /*! + \fn QPixmap QDesignerFormWindowManagerInterface::createPreviewPixmap() const + + Creates a pixmap representing the preview of the currently active form. +*/ + +/*! Allows you to intervene and control \QD's "undo" action. The function returns the original action. diff --git a/src/designer/src/lib/shared/qdesigner_formwindowmanager.cpp b/src/designer/src/lib/shared/qdesigner_formwindowmanager.cpp index 9b7d4afde..a9fb8fcad 100644 --- a/src/designer/src/lib/shared/qdesigner_formwindowmanager.cpp +++ b/src/designer/src/lib/shared/qdesigner_formwindowmanager.cpp @@ -36,7 +36,7 @@ QT_BEGIN_NAMESPACE using namespace qdesigner_internal; /*! - \class QDesignerFormWindowManager + \class qdesigner_internal::QDesignerFormWindowManager \inmodule QtDesigner Extends QDesignerFormWindowManagerInterface with methods to control @@ -58,7 +58,7 @@ QDesignerFormWindowManager::~QDesignerFormWindowManager() } /*! - \fn PreviewManager *QDesignerFormWindowManager::previewManager() const + \fn PreviewManager *qdesigner_internal::QDesignerFormWindowManager::previewManager() const Accesses the previewmanager implementation. |