From: Chris Adams <christopher.adams@nokia.com>
Date: Fri, 6 Jul 2012 06:36:11 +0000 (+1000)
Subject: Include QQmlExpression in QtQml module CppClasses docs
X-Git-Tag: upstream/5.2.1~1446
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=cf507172d6aa281036cde02ded9493535685fd80;p=platform%2Fupstream%2Fqtdeclarative.git

Include QQmlExpression in QtQml module CppClasses docs

This commit just adds the structure and the topic page entry.
The actual content for the in-depth page has yet to be written.

Change-Id: Iee083fe091c612d235bffb64ca38a8e06cc3b9e4
Reviewed-by: Michael Brasser <michael.brasser@nokia.com>
---

diff --git a/src/qml/doc/src/cppclasses/expression.qdoc b/src/qml/doc/src/cppclasses/expression.qdoc
new file mode 100644
index 0000000..76db1ce
--- /dev/null
+++ b/src/qml/doc/src/cppclasses/expression.qdoc
@@ -0,0 +1,36 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** 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$
+**
+****************************************************************************/
+
+/*!
+\page qtqml-cppclasses-expression.html
+\title Qt QML Module C++ Classes - QQmlExpression
+\brief Description of QQmlExpression
+
+QQmlExpression provides a C++ interface to evaluate JavaScript expressions
+within a particular QML context.
+
+*/
diff --git a/src/qml/doc/src/cppclasses/topic.qdoc b/src/qml/doc/src/cppclasses/topic.qdoc
index 24d0674..64f02c9 100644
--- a/src/qml/doc/src/cppclasses/topic.qdoc
+++ b/src/qml/doc/src/cppclasses/topic.qdoc
@@ -65,4 +65,16 @@ are resolved, and thus which values the expression operates on.
 See \l{qtqml-cppclasses-context.html}{Qt QML Module C++ Classes - QQmlContext}
 for in-depth information about QQmlContext.
 
+\section1 The QQmlExpression Class
+
+The QQmlExpression class provides a way for clients to evaluate JavaScript
+expressions from C++, using a particular QML evaluation context.  This allows
+clients to access QML objects by id, for example.  The result of evaluation
+is returned as a QVariant, and the conversion rules are defined by the QML
+engine.
+
+See \l{qtqml-cppclasses-expression.html}
+{Qt QML Module C++ Classes - QQmlExpression} for in depth information about
+QQmlExpression.
+
 */