From 114a878c64ce6f8223cfd22d76a20eb16d177e5e Mon Sep 17 00:00:00 2001 From: toma Date: Wed, 25 Nov 2009 17:56:58 +0000 Subject: Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdevelop@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da --- languages/lib/debugger/Mainpage.dox | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 languages/lib/debugger/Mainpage.dox (limited to 'languages/lib/debugger/Mainpage.dox') diff --git a/languages/lib/debugger/Mainpage.dox b/languages/lib/debugger/Mainpage.dox new file mode 100644 index 00000000..2e141fd3 --- /dev/null +++ b/languages/lib/debugger/Mainpage.dox @@ -0,0 +1,36 @@ +/** +@mainpage The KDevelop %Debugger Support Library + +This library contains classes to implement debugger support for a programming language. + +Link with: -llang_debugger + +Include path: -I\$(kde_includes)/kdevelop/languages/debugger + +\section usingdebugger Where to use this library + +Each debugger support plugin must interact with an editor to set breakpoints, +jump to execution points, etc. This kind of interaction is implemented in +@ref Debugger class. Your debugger support plugin just need to create +an instance of @ref Debugger class and connect its signals, for example: +@code +m_debugger = new Debugger( partController() ); + +connect( m_debugger, SIGNAL(toggledBreakpoint(const QString &, int)), + debuggerBreakpointWidget, SLOT(slotToggleBreakpoint(const QString &, int)) ); +connect( m_debugger, SIGNAL(editedBreakpoint(const QString &, int)), + debuggerBreakpointWidget, SLOT(slotEditBreakpoint(const QString &, int)) ); +connect( m_debugger, SIGNAL(toggledBreakpointEnabled(const QString &, int)), + debuggerBreakpointWidget, SLOT(slotToggleBreakpointEnabled(const QString &, int)) ); +@endcode +Then m_debugger instance can be used for example, to jump to the execution point: +@code +m_debugger->gotoExecutionPoint(fileUrl, lineNumber); +@endcode +or to set a breakpoint: +@code +m_debugger->setBreakpoint(fileName, lineNumber, id, enabled, pending); +@endcode + +*/ + -- cgit v1.2.3