From 7ce2c0c9ac65c6e6ee8c50af0f649e3e6e05acfd Mon Sep 17 00:00:00 2001
From: Mitch Curtis <mitch.curtis@theqtcompany.com>
Date: Tue, 28 Oct 2014 10:04:08 +0100
Subject: [PATCH] Fix Canvas documentation.
getContext documentation wasn't showing up due to a syntax error:
"any ..."
Also fixed some small issues here and there.
Change-Id: I3c0444d25bd0fea72fb4fcbf07b3e00794ff1414
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
---
src/quick/items/context2d/qquickcanvasitem.cpp | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/src/quick/items/context2d/qquickcanvasitem.cpp b/src/quick/items/context2d/qquickcanvasitem.cpp
index 15eb28350e..c31b7726c4 100644
--- a/src/quick/items/context2d/qquickcanvasitem.cpp
+++ b/src/quick/items/context2d/qquickcanvasitem.cpp
@@ -313,7 +313,7 @@ QQuickCanvasItem::~QQuickCanvasItem()
}
/*!
- \qmlproperty size QtQuick::Canvas::available
+ \qmlproperty bool QtQuick::Canvas::available
Indicates when Canvas is able to provide a drawing context to operate on.
*/
@@ -790,18 +790,18 @@ QSGTextureProvider *QQuickCanvasItem::textureProvider() const
}
/*!
- \qmlmethod object QtQuick::Canvas::getContext(string contextId, any... args)
+ \qmlmethod object QtQuick::Canvas::getContext(string contextId, ... args)
- Returns a drawing context or null if no context available.
+ Returns a drawing context, or \c null if no context is available.
The \a contextId parameter names the required context. The Canvas item
will return a context that implements the required drawing mode. After the
- first call to getContext any subsequent call to getContext with the same
+ first call to getContext, any subsequent call to getContext with the same
contextId will return the same context object.
If the context type is not supported or the canvas has previously been
- requested to provide a different and incompatible context type, null will
- be returned.
+ requested to provide a different and incompatible context type, \c null
+ will be returned.
Canvas only supports a 2d context.
*/
--
GitLab