Amend the documention of search profile, fu r86714
authorNiklas Laxström <nikerabbit@users.mediawiki.org>
Wed, 17 Aug 2011 09:50:54 +0000 (09:50 +0000)
committerNiklas Laxström <nikerabbit@users.mediawiki.org>
Wed, 17 Aug 2011 09:50:54 +0000 (09:50 +0000)
includes/specials/SpecialSearch.php

index 2574393..4da63de 100644 (file)
  * @ingroup SpecialPage
  */
 class SpecialSearch extends SpecialPage {
-       /// Current search profile
+       /**
+        * Current search profile. Search profile is just a name that identifies
+        * the active search tab on the search page (content, help, discussions...)
+        * For users tt replaces the set of enabled namespaces from the query
+        * string when applicable. Extensions can add new profiles with hooks
+        * with custom search options just for that profile.
+        * null|string
+        */ 
        protected $profile;
 
        /// Search engine