From 3b412c597c03e805d999364803ae07e564451504 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Tue, 30 Jul 2013 15:05:47 +0200 Subject: Doc: edit qtwinextras module documentation Added a lot of articles, fixed typos and grammar errors, enforced the Qt doc writing style, and used standard wording for qdoc commands. Change-Id: Ia644907e5d8454ddd789ab214a93fe7524aaf206 Reviewed-by: Friedemann Kleint Reviewed-by: Geir Vattekar Reviewed-by: Jake Petroules --- src/imports/winextras/JumpDestination.qml | 2 +- src/imports/winextras/JumpLink.qml | 8 ++++---- src/imports/winextras/qquickjumplist.cpp | 10 +++++----- src/imports/winextras/qquickwindwmfeatures.cpp | 18 ++++++++++-------- src/imports/winextras/qquickwintaskbarbutton.cpp | 23 +++++++++++++---------- 5 files changed, 33 insertions(+), 28 deletions(-) (limited to 'src/imports') diff --git a/src/imports/winextras/JumpDestination.qml b/src/imports/winextras/JumpDestination.qml index 5625e5e..44c7aa0 100644 --- a/src/imports/winextras/JumpDestination.qml +++ b/src/imports/winextras/JumpDestination.qml @@ -55,7 +55,7 @@ JumpListItem { /*! \qmlproperty string JumpDestination::filePath - Path of the file. + The path to the file. */ property string filePath } diff --git a/src/imports/winextras/JumpLink.qml b/src/imports/winextras/JumpLink.qml index e7d779d..37d14ab 100644 --- a/src/imports/winextras/JumpLink.qml +++ b/src/imports/winextras/JumpLink.qml @@ -55,14 +55,14 @@ JumpListItem { /*! \qmlproperty string JumpLink::iconPath - Path to link icon. + The path to a link icon. */ property string iconPath /*! \qmlproperty string JumpLink::executablePath - Path to executable file. + The path to an executable file. */ property string executablePath @@ -76,14 +76,14 @@ JumpListItem { /*! \qmlproperty string JumpLink::description - Description of the link. + The description of the link. */ property string description /*! \qmlproperty string JumpLink::title - Title of the link. + The title of the link. */ property string title } diff --git a/src/imports/winextras/qquickjumplist.cpp b/src/imports/winextras/qquickjumplist.cpp index 11cdfb9..e4caeaf 100644 --- a/src/imports/winextras/qquickjumplist.cpp +++ b/src/imports/winextras/qquickjumplist.cpp @@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE \instantiates QQuickJumpList \inqmlmodule QtWinExtras - \brief The JumpList item allows modifying application Jump List. + \brief Enables you to modify the application Jump List. */ /*! @@ -85,7 +85,7 @@ QQmlListProperty QQuickJumpList::destinations() /*! \qmlproperty bool JumpList::showFrequentCategory - Contains true if 'frequent' category is shown, false otherwise. + Contains true if the \e Frequent category is shown; otherwise false. */ bool QQuickJumpList::showFrequentCategory() const { @@ -100,7 +100,7 @@ void QQuickJumpList::setShowFrequentCategory(bool show) /*! \qmlproperty bool JumpList::showRecentCategory - Contains true if 'recent' category is shown, false otherwise. + Contains true if the \e Recent category is shown; otherwise false. */ bool QQuickJumpList::showRecentCategory() const { @@ -174,7 +174,7 @@ QQuickJumpListCategory::~QQuickJumpListCategory() /*! \qmlproperty object JumpCategory::destinations - Destinations in this category. + The destinations in this category. */ QQmlListProperty QQuickJumpListCategory::destinations() { @@ -189,7 +189,7 @@ void QQuickJumpListCategory::setTitle(const QString &title) /*! \qmlproperty string JumpCategory::title - Title of the category. + The title of the category. */ QString QQuickJumpListCategory::title() const { diff --git a/src/imports/winextras/qquickwindwmfeatures.cpp b/src/imports/winextras/qquickwindwmfeatures.cpp index cbdbbb9..0f4068a 100644 --- a/src/imports/winextras/qquickwindwmfeatures.cpp +++ b/src/imports/winextras/qquickwindwmfeatures.cpp @@ -54,7 +54,8 @@ QT_BEGIN_NAMESPACE \instantiates QQuickWinDwmFeatures \inqmlmodule QtWinExtras - \brief The WinDwmFeatures item allows extending glass frame into client area, as well as controlling behavior of Aero Peek and Flip3D. + \brief Enables you to extend a glass frame into the client area, as well as + to control the behavior of Aero Peek and Flip3D. */ /*! @@ -102,7 +103,7 @@ bool QQuickWinDwmFeatures::colorizationOpaqueBlend() const /*! \qmlproperty int WinDwmFeatures::topGlassMargin - Top glass frame height. Default value is 0. + The top glass frame margin. The default value is 0. */ void QQuickWinDwmFeatures::setTopGlassMargin(int margin) { @@ -114,7 +115,7 @@ void QQuickWinDwmFeatures::setTopGlassMargin(int margin) /*! \qmlproperty int WinDwmFeatures::rightGlassMargin - Right glass frame width. Default value is 0. + The right glass frame margin. The default value is 0. */ void QQuickWinDwmFeatures::setRightGlassMargin(int margin) { @@ -126,7 +127,7 @@ void QQuickWinDwmFeatures::setRightGlassMargin(int margin) /*! \qmlproperty int WinDwmFeatures::bottomGlassMargin - Bottom glass frame height. Default value is 0. + The bottom glass frame margin. The default value is 0. */ void QQuickWinDwmFeatures::setBottomGlassMargin(int margin) { @@ -138,7 +139,7 @@ void QQuickWinDwmFeatures::setBottomGlassMargin(int margin) /*! \qmlproperty int WinDwmFeatures::leftGlassMargin - Left glass frame width. Default value is 0. + The left glass frame margin. The default value is 0. */ void QQuickWinDwmFeatures::setLeftGlassMargin(int margin) { @@ -195,8 +196,9 @@ void QQuickWinDwmFeatures::setExcludedFromPeek(bool exclude) /*! \qmlproperty bool WinDwmFeatures::peekDisallowed - Default is false. Set this to \c true if you want to forbid Aero Peek when user hovers mouse on window thumbnail. - */ + Set this value to true if you want to forbid Aero Peek when the user hovers + the mouse over the window thumbnail. The default value is false. +*/ bool QQuickWinDwmFeatures::peekDisallowed() const { Q_D(const QQuickWinDwmFeatures); @@ -221,7 +223,7 @@ void QQuickWinDwmFeatures::setPeekDisallowed(bool disallow) /*! \qmlproperty WinDwmFeatures::Flip3DPolicy WinDwmFeatures::flip3DPolicy - Contains current Flip3D policy for the window. + The current Flip3D policy for the window. */ QQuickWinDwmFeatures::Flip3DPolicy QQuickWinDwmFeatures::flip3DPolicy() const { diff --git a/src/imports/winextras/qquickwintaskbarbutton.cpp b/src/imports/winextras/qquickwintaskbarbutton.cpp index 52555f5..24ec347 100644 --- a/src/imports/winextras/qquickwintaskbarbutton.cpp +++ b/src/imports/winextras/qquickwintaskbarbutton.cpp @@ -50,7 +50,9 @@ QT_BEGIN_NAMESPACE \instantiates QQuickWinTaskbarButton \inqmlmodule QtWinExtras - \brief The WinTaskbarButton item allows setting overlay icons on a button, displaying progress indicator and adding small toolbar to window thumbnail popup.. + \brief Enables you to set overlay icons on a taskbar button, to display a + progress indicator, and to add a small toolbar to the window thumbnail + popup. \sa QWinTaskbarButton */ @@ -82,7 +84,7 @@ void QQuickWinTaskbarButton::setProgressMinimum(int min) /*! \qmlproperty int WinTaskbarButton::progressMaximum - Maximum progress value. + The maximum progress value. */ int QQuickWinTaskbarButton::progressMaximum() const { @@ -97,7 +99,7 @@ void QQuickWinTaskbarButton::setProgressMaximum(int max) /*! \qmlproperty int WinTaskbarButton::progressValue - Displayed progress value. + The displayed progress value. */ int QQuickWinTaskbarButton::progressValue() const { @@ -112,7 +114,7 @@ void QQuickWinTaskbarButton::setProgressValue(int progress) /*! \qmlproperty string WinTaskbarButton::icon - Overlay icon path. + The overlay icon path. */ QString QQuickWinTaskbarButton::overlayIcon() const { @@ -128,7 +130,7 @@ void QQuickWinTaskbarButton::setOverlayIcon(const QString &path) /*! \qmlproperty int WinTaskbarButton::iconDescription - Accessibility description for overlay icon. + The accessibility description for the overlay icon. */ QString QQuickWinTaskbarButton::iconDescription() const { @@ -144,22 +146,23 @@ void QQuickWinTaskbarButton::setIconDescription(const QString &descr) /*! \qmlproperty enumeration WinTaskbarButton::progressState - State of progress indicator. + The state of the progress indicator. The state can be one of the following: \table \header \li Value \li Description \row \li NoProgressState - \li No progress indicator. + \li No progress indicator is displayed. \row \li IndeterminateState \li The progress indicator cycles repeatedly. \row \li NormalState - \li + \li The progress indicator is green. \row \li PausedState - \li Indicator turns yellow. Use that to show that operation has been paused, but can be continued. + \li The progress indicator turns yellow. Use this state to show that the + operation has been paused, but it can be continued. \row \li ErrorState - \li Indicator turns red. + \li The progress indicator turns red. \endtable */ QWinTaskbarButton::ProgressState QQuickWinTaskbarButton::progressState() const -- cgit v1.2.3