From 1a84b190bd1a2781d03f13fa43ab92bf34809041 Mon Sep 17 00:00:00 2001 From: Alan Alpert Date: Mon, 8 Aug 2011 18:03:31 +1000 Subject: Add documentation Copy the documentation back to the scenegraph items, and update it to the new module syntax. Change-Id: I5d030a231f991a209a8593ddb069e1b6cd03580e Reviewed-on: http://codereview.qt.nokia.com/2735 Reviewed-by: Michael Brasser --- doc/src/declarative/elements.qdoc | 2 +- doc/src/declarative/qtquick1.qdoc | 7 +++++-- doc/src/declarative/qtquick2.qdoc | 38 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 44 insertions(+), 3 deletions(-) create mode 100644 doc/src/declarative/qtquick2.qdoc (limited to 'doc') diff --git a/doc/src/declarative/elements.qdoc b/doc/src/declarative/elements.qdoc index a861a66a58..bcabaccc00 100644 --- a/doc/src/declarative/elements.qdoc +++ b/doc/src/declarative/elements.qdoc @@ -32,7 +32,7 @@ \brief A listing of standard QML elements. These are the functionally grouped lists of QML elements as part of -\l{Qt Quick}. +\l{Qt Quick}. You can also browse the module pages for \l{QtQuick 1}, \l{QtQuick 2} and \l{QtQuick.Particles 2} Elements are declared with the their name and two curly braces. Elements may be nested in elements, thereby creating a parent-child relationship between the diff --git a/doc/src/declarative/qtquick1.qdoc b/doc/src/declarative/qtquick1.qdoc index ee4a4565e8..c5e2190ee3 100644 --- a/doc/src/declarative/qtquick1.qdoc +++ b/doc/src/declarative/qtquick1.qdoc @@ -32,6 +32,9 @@ \brief The QML Elements This QML module contains all the QML elements that are - instantiated as objects of C++ classes in the QtDeclarative - module. + instantiated as objects of C++ classes in the QtQuick1 + module. These elements are QGraphicsObject based, and + work with the Graphics View framework. In Qt 5, they + have been replaced by \l{QtQuick 2}, based on the + Scenegraph renderer. */ diff --git a/doc/src/declarative/qtquick2.qdoc b/doc/src/declarative/qtquick2.qdoc new file mode 100644 index 0000000000..49083f853e --- /dev/null +++ b/doc/src/declarative/qtquick2.qdoc @@ -0,0 +1,38 @@ +/**************************************************************************** +** +** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** GNU Free Documentation License +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. +** +** Other Usage +** Alternatively, this file may be used in accordance with the terms +** and conditions contained in a signed written agreement between you +** and Nokia. +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \qmlmodule QtQuick 2 + \title QML Module QtQuick 2 + + \brief The QML Elements + + This QML module contains all the QML elements that are + instantiated as objects of C++ classes in the QtDeclarative + module. These elements work with the Scenegraph renderer and + their own canvas. + */ -- cgit v1.2.3