diff options
| author | Jesper K. Pedersen <jesper.pedersen@kdab.com> | 2013-04-16 11:00:46 +0200 |
|---|---|---|
| committer | Jesper K. Pedersen <jesper.pedersen@kdab.com> | 2013-04-16 14:39:05 +0200 |
| commit | 00add1de4c386fa4ca103ccf21770c1ea102d0df (patch) | |
| tree | d4fffe5a46cabec3554a2ea2e230a38f1a28b37f /scriptingplugin.h | |
| parent | 2b5cef70f34064f1c2ddea77ca5da6933a617dd6 (diff) | |
Added Doxygen documentation
Change-Id: Ib9ef7ba4a52c89e3fc8a22ed0463b5dfd6c326be
Reviewed-by: Nicolas Arnaud-Cormos <nicolas@kdab.com>
Reviewed-by: Jesper K. Pedersen <jesper.pedersen@kdab.com>
Diffstat (limited to 'scriptingplugin.h')
| -rw-r--r-- | scriptingplugin.h | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/scriptingplugin.h b/scriptingplugin.h index 68f416a..0d73882 100644 --- a/scriptingplugin.h +++ b/scriptingplugin.h @@ -37,6 +37,25 @@ #include <extensionsystem/iplugin.h> +/** + \mainpage + + <h1>Overall design</h1> + + \li It all starts in \ref Scripting::Internal::ScriptingPlugin which is executed by Qt Creator at startup. + \li The script runner registers a locator action called <b>rs</b> - see \ref Scripting::Internal::RunScriptLocatorFilter + \li The ground work of finding scripts, registering shortcuts and starting their execution is done in \ref Scripting::Internal::ScriptManager + \li \ref Scripting::Internal::ScriptRunner contains the JavaScript engine and register the objects available in the scripts + + <h1>Objects available in the scripts</h1> + + \li <b>console</b> accesses an instance of \ref Scripting::Internal::Console + \code console.log("Hello world")\endcode + + \li <b>editors</b> accesses an instance of \ref Scripting::Internal::Editors. + \code editors.current().selectAll()\endcode +*/ + namespace Scripting { namespace Internal { |