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

List:       kde-commits
Subject:    branches/KDE/4.5/kdelibs/kio/kio
From:       Dawit Alemayehu <adawit () kde ! org>
Date:       2010-08-27 20:23:46
Message-ID: 20100827202346.937B4AC857 () svn ! kde ! org
[Download RAW message or body]

SVN commit 1168909 by adawit:

Make the function API documentation as clear as possible to avoid ambiguity

 M  +7 -9      kurifilter.h  


--- branches/KDE/4.5/kdelibs/kio/kio/kurifilter.h #1168908:1168909
@@ -248,22 +248,20 @@
      * Returns a list of the names of the preferred search providers.
      *
      * This function returns the list of providers that are marked as favorite
-     * or preferred by the user whenever this data is filtered through by the
-     * search uri filter plugin 'kurisearchfilter'.
+     * or preferred by the user whenever the data it contains is filtered by the
+     * 'kuriikwsfilter' search uri filter plugin.
      *
-     * If there are no search providers marked favorite or chosen as a default
-     * search provider by the user, then this function will return an empty list.
+     * If no prior search providers were marked preferred or no default search
+     * engine was selected, then this function will return an empty list unless
+     * you set alternate default or search providers using the appropriate function.
+     * See @ref setAlternateDefaultSearchProvider and @ref setAlternateSearchProviders.
      *
-     * This function will also return an empty list if the data is not filtered by
-     * one of the two search uri filter plugins, 'kurisearchfilter' and
-     * 'kuriikwsfilter'.
-     *
      * You can use @ref queryForPreferredServiceProvider to obtain the queries
      * associated with the returned search providers.
      *
      * @see searchProvider
      * @see alternateSearchProviders
-     * @see alternateDefaultSearchProviders
+     * @see alternateDefaultSearchProvider
      * @see queryForPreferredServiceProvider
      * @since 4.5
      */
[prev in list] [next in list] [prev in thread] [next in thread]