From 662ba874795045558374a61c85a7e3c2de5bbdbb Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Sun, 11 Mar 2012 23:41:13 +0000 Subject: [PATCH] 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 --- interface/wx/help.h | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/interface/wx/help.h b/interface/wx/help.h index 574ee27947..85d616c60e 100644 --- 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. -- 2.47.2