From 8759cf3fcb3b78a7b62e7f4feedee8e6822bde32 Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Tue, 22 Jan 2013 18:00:26 +0100 Subject: Doc: Modularized Qt Script Tools documentation. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit -moved content from qtdoc -moved snippets to src/scripttools -enabled 'make docs' -edited QScriptEngineDebugger with the proper module identifier -created two way links from Qt Script to Qt Script Tools Change-Id: I83a76278969528dcb1ecbca4acc8563fe9390978 Reviewed-by: Jędrzej Nowacki Reviewed-by: Geir Vattekar --- src/scripttools/debugging/qscriptenginedebugger.cpp | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'src/scripttools/debugging') diff --git a/src/scripttools/debugging/qscriptenginedebugger.cpp b/src/scripttools/debugging/qscriptenginedebugger.cpp index b6df016..6a6bd14 100644 --- a/src/scripttools/debugging/qscriptenginedebugger.cpp +++ b/src/scripttools/debugging/qscriptenginedebugger.cpp @@ -70,12 +70,12 @@ public: }; /*! - \since 4.5 - \class QScriptEngineDebugger + \since 4.5 + \class QScriptEngineDebugger + \inmodule QtScriptTools + \brief The QScriptEngineDebugger class provides a QScriptEngine debugger. - \brief The QScriptEngineDebugger class provides a QScriptEngine debugger. - - \ingroup script + \ingroup script The QScriptEngineDebugger class provides a debugger that can be @@ -86,7 +86,7 @@ public: To attach the debugger to a script engine, call the attachTo() function. - \snippet code/src.scripttools.qscriptenginedebugger.cpp 0 + \snippet src.scripttools.qscriptenginedebugger.cpp 0 Once the debugger has been attached to a script engine, you can proceed to evaluate scripts as usual, e.g. by calling @@ -140,7 +140,7 @@ public: the function call does not return until the user has finished interacting with the debugger. - \snippet code/src.scripttools.qscriptenginedebugger.cpp 1 + \snippet src.scripttools.qscriptenginedebugger.cpp 1 When the Qt Script debugger is running, the C++ application itself is not "frozen". This means that it is possible that more scripts -- cgit v1.2.1 From 19550797aa16ee60fc19fdaf90832b4895612226 Mon Sep 17 00:00:00 2001 From: Sze Howe Koh Date: Fri, 25 Jan 2013 20:40:36 +0800 Subject: Doc: Fix module name format Follow the conventions at http://qt-project.org/wiki/Spelling_Module_Names_in_Qt_Documentation QtScript -> Qt Script QtScriptTools -> Qt Script Tools Change-Id: Icf6b2ea3829247475f8902334b615f9a9206cc51 Reviewed-by: Jerome Pasion --- src/scripttools/debugging/qscriptenginedebugger.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src/scripttools/debugging') diff --git a/src/scripttools/debugging/qscriptenginedebugger.cpp b/src/scripttools/debugging/qscriptenginedebugger.cpp index f612ec4..e5e7062 100644 --- a/src/scripttools/debugging/qscriptenginedebugger.cpp +++ b/src/scripttools/debugging/qscriptenginedebugger.cpp @@ -166,7 +166,7 @@ public: currently not supported. If you need to debug painting-related script code, that code should be evaluated outside of the C++ paintEvent(), e.g. by rendering to an image, like the Context2D and - Tetrix QtScript examples do. This will make the code safe for + Tetrix Qt Script examples do. This will make the code safe for debugging. The debugger adds some special properties to the script engine: -- cgit v1.2.1