[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    [sprinter/gko/master] docs: clean up docs
From:       Aaron J. Seigo <aseigo () kde ! org>
Date:       2014-03-06 10:20:26
Message-ID: E1WLVPe-0007ZS-1f () scm ! kde ! org
[Download RAW message or body]

Git commit 181d9b8da96de383165f352f7a1c31faaa1af4ab by Aaron J. Seigo.
Committed on 26/02/2014 at 14:29.
Pushed by aseigo into branch 'gko/master'.

clean up docs

M  +3    -8    docs/Porting_KRunner_Plugins.txt
M  +1    -1    docs/Runners.txt

http://commits.kde.org/sprinter/181d9b8da96de383165f352f7a1c31faaa1af4ab

diff --git a/docs/Porting_KRunner_Plugins.txt b/docs/Porting_KRunner_Plugins.txt
index 77d8af3..78f5b05 100644
--- a/docs/Porting_KRunner_Plugins.txt
+++ b/docs/Porting_KRunner_Plugins.txt
@@ -25,17 +25,12 @@ Next, change this:
 
 to:
 
-    void match(Sprinter::RunnerSessionData *sessionData,
-               const Sprinter::QueryContext &context);
+    void match(Sprinter::MatchData &matchData);
     bool exec(const Sprinter::QueryMatch &match);
 
-All references to QList<Plasma::QueryMatch> will need to be changed to \
QVector<Sprinter::QueryMatch>, and then change: +All references to \
QList<Plasma::QueryMatch> are replaced by adding matches to the matchData object:  
-    context.addMatches(context.query(), matches);
-
-to:
-
-    sessionData->setMatches(matches, context);
+    matchData << match;
 
 In the constructor of the Sprinter::Runner method, add declarations of what kind of \
matches the plugin provides:  
diff --git a/docs/Runners.txt b/docs/Runners.txt
index 2e751a4..c464726 100644
--- a/docs/Runners.txt
+++ b/docs/Runners.txt
@@ -55,7 +55,7 @@ You may notice that there is an "enabled" property in \
RunnerSessionData. However  
 == Fast Synchronous Matching
 
-Runners whose query matching is necessarily synchronous, either because a library \
they are using only offers a synchronous API or because the matching is fast (e.g. \
sub-100ms), can take the easiest approach: reimplement Runner::match and call \
RunnerSessionData::setMatches at least once, even on failure (this will clear the set \
of matches). +Runners whose query matching is necessarily synchronous, either because \
a library they are using only offers a synchronous API or because the matching is \
fast (e.g. sub-100ms), can take the easiest approach: reimplement Runner::match and \
add matches (if any) to the MatchData object passed to it.  
 == Slow Synchronous Matching
 


[prev in list] [next in list] [prev in thread] [next in thread]