summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--doc/src/declarative/pics/qmldebugger-creator.pngbin0 -> 170972 bytes
-rw-r--r--doc/src/declarative/qmldebugging.qdoc53
-rw-r--r--tools/qmldebugger/creatorplugin/QmlInspector.pluginspec12
-rw-r--r--tools/qmldebugger/creatorplugin/README6
4 files changed, 63 insertions, 8 deletions
diff --git a/doc/src/declarative/pics/qmldebugger-creator.png b/doc/src/declarative/pics/qmldebugger-creator.png
new file mode 100644
index 0000000..da1e22d
--- /dev/null
+++ b/doc/src/declarative/pics/qmldebugger-creator.png
Binary files differ
diff --git a/doc/src/declarative/qmldebugging.qdoc b/doc/src/declarative/qmldebugging.qdoc
index b5b58a6..13ad5f7 100644
--- a/doc/src/declarative/qmldebugging.qdoc
+++ b/doc/src/declarative/qmldebugging.qdoc
@@ -59,8 +59,57 @@ Rectangle {
\section1 The QML Inspector
-qmldebugger provides an experimental inspector to aid with debugging. It can
-be run as a Qt Creator plugin or as a standalone application.
+The \c qmldebugger tool provides an experimental inspector to aid with debugging.
+It can be run as a Qt Creator plugin or as a standalone application.
+
+\section2 Qt Creator plugin
+
+The Qt Creator plugin currently builds against Qt Creator 1.3.
+
+To build the Qt Creator plugin:
+
+\list
+\o Set an environment variable \c CREATOR_SRC_DIR that points to the Qt Creator
+ source directory
+\o Set an environment variable \c CREATOR_BUILD_DIR that points to the Qt Creator
+ build directory
+\o Run \c qmake on \c $QTDIR/tools/qmldebugger/qmldebugger.pro
+\endlist
+
+This builds the plugin into your Qt Creator installation.
+
+The plugin adds a "QML Inspect" mode into Qt Creator that provides:
+
+\list
+\o An object tree showing all objects and their children
+\o The current property values for the object selected in the object tree
+ (this table is dynamically updated for all properties that have property changed
+ notifications)
+\o An expression evaluator for querying and setting values dynamically
+\o A table of watched properties (double-click on a property in the property
+ table to add it to the watch table)
+\o A graph that shows the frame rate of your application
+\endlist
+
+
+To start the debugger, open a QML project and click the "QML Inspect" mode, then click the green
+"play" button in the toolbar of the bottom-right debugger window.
+
+\image qmldebugger-creator.png
+
+
+\section2 Standalone qmldebugger tool
+
+To run the standalone \c qmldebugger tool, set an environment variable \c QML_DEBUG_SERVER_PORT
+to an available port number and run the \c qmlviewer. For example:
+
+\code
+ QML_DEBUG_SERVER_PORT=3768 qmlviewer myqmlfile.qml
+\endcode
+
+Then in another process, start the \c qmldebugger tool, enter the port number into the corresponding spinbox
+in the top right hand corner, and press the "Connect" button.
+
\section1 Debugging Transitions
diff --git a/tools/qmldebugger/creatorplugin/QmlInspector.pluginspec b/tools/qmldebugger/creatorplugin/QmlInspector.pluginspec
index cdba135..1cf12cf 100644
--- a/tools/qmldebugger/creatorplugin/QmlInspector.pluginspec
+++ b/tools/qmldebugger/creatorplugin/QmlInspector.pluginspec
@@ -19,10 +19,10 @@ will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.</license>
<description>Qml support</description>
<url>http://qt.nokia.com</url>
<dependencyList>
- <dependency name="QmlProjectManager" version="1.3.80"/>
- <dependency name="ProjectExplorer" version="1.3.80"/>
- <dependency name="CppTools" version="1.3.80"/>
- <dependency name="CppEditor" version="1.3.80"/>
- <dependency name="Help" version="1.3.80"/>
+ <dependency name="QmlProjectManager" version="1.3.0"/>
+ <dependency name="ProjectExplorer" version="1.3.0"/>
+ <dependency name="CppTools" version="1.3.0"/>
+ <dependency name="CppEditor" version="1.3.0"/>
+ <dependency name="Help" version="1.3.0"/>
</dependencyList>
-</plugin> \ No newline at end of file
+</plugin>
diff --git a/tools/qmldebugger/creatorplugin/README b/tools/qmldebugger/creatorplugin/README
index e7e205e..5723dca 100644
--- a/tools/qmldebugger/creatorplugin/README
+++ b/tools/qmldebugger/creatorplugin/README
@@ -1,5 +1,11 @@
+The qmldebugger Qt Creator plugin currently builds with Qt Creator 1.3.
+
To enable this project, qmldebugger.pro requires that these two environment
variables be defined:
CREATOR_SRC_DIR -> source directory for Qt Creator
CREATOR_BUILD_DIR -> build directory for Qt Creator
+
+Once these are defined, run qmake on qmldebugger.pro.
+
+The project will be built into Creator's plugin directory.