Document wxHelpSearchMode enum and its values.

Closes #14090.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70875 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/interface/wx/help.h b/interface/wx/help.h
index 574ee279478710ae5b7319be7714a729004b172e..85d616c60e8cfc3bd0e82f05e8c719c5abe4ffa0 100644 (file)
--- a/interface/wx/help.h
+++ b/interface/wx/help.h
@@ -6,6 +6,15 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
+/**
+    Help search modes for wxHelpController::KeywordSearch().
+ */
+enum wxHelpSearchMode
+{
+    wxHELP_SEARCH_INDEX,    ///< Search the index only.
+    wxHELP_SEARCH_ALL       ///< Search all entries.
+};
+
 /**
     @class wxHelpController
 
@@ -182,8 +191,8 @@ public:
     /**
         If the help viewer is not running, runs it, and searches for sections matching
         the given keyword. If one match is found, the file is displayed at this section.
-        The optional parameter allows the search the index (wxHELP_SEARCH_INDEX)
-        but this currently only supported by the wxHtmlHelpController.
+        The optional parameter allows to search the index (wxHELP_SEARCH_INDEX)
+        but this currently is only supported by the wxHtmlHelpController.
 
         - @e WinHelp, MS HTML Help:
           If more than one match is found, the first topic is displayed.