From bc5fc28a621b8bc11ed9367f8b0fce58a6852a9f Mon Sep 17 00:00:00 2001 From: =?utf8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sun, 11 Feb 2018 20:58:47 +0100 Subject: [PATCH] doxygen: improve the search help text. --- doxygen/dox2html5.py | 8 +++++++- doxygen/templates/base.html | 2 +- doxygen/test/layout_minimal/index.html | 7 ++++++- doxygen/test/layout_search_binary/Doxyfile | 1 + doxygen/test/layout_search_binary/index.html | 2 +- doxygen/test/test_doxyfile.py | 9 +++++++-- 6 files changed, 23 insertions(+), 6 deletions(-) diff --git a/doxygen/dox2html5.py b/doxygen/dox2html5.py index e7b47559..8de8f179 100755 --- a/doxygen/dox2html5.py +++ b/doxygen/dox2html5.py @@ -2606,7 +2606,13 @@ def parse_doxyfile(state: State, doxyfile, config = None): 'M_PAGE_FINE_PRINT': ['[default]'], 'M_SEARCH_DISABLED': ['NO'], 'M_SEARCH_DOWNLOAD_BINARY': ['NO'], - 'M_SEARCH_HELP': ['Search for symbols, headers, pages or example source files. You can omit any prefix from the symbol or file path.'], + 'M_SEARCH_HELP': [ +"""Search for symbols, directories, files, pages or modules. You can omit any +prefix from the symbol or file path; adding a : or / +suffix lists all members of given symbol or directory. Navigate through the +list using ↓ and +↑, press +Enter to go."""], 'M_SEARCH_EXTERNAL_URL': [''] } diff --git a/doxygen/templates/base.html b/doxygen/templates/base.html index b1acb216..2f503f6f 100644 --- a/doxygen/templates/base.html +++ b/doxygen/templates/base.html @@ -106,7 +106,7 @@
- {{ M_SEARCH_HELP }} + {{ M_SEARCH_HELP|indent(12) }}
Sorry, nothing was found.{% if M_SEARCH_EXTERNAL_URL %}
Maybe try a full-text search with external engine?{% endif %}
diff --git a/doxygen/test/layout_minimal/index.html b/doxygen/test/layout_minimal/index.html index fe3e2014..4a692453 100644 --- a/doxygen/test/layout_minimal/index.html +++ b/doxygen/test/layout_minimal/index.html @@ -62,7 +62,12 @@
- Search for symbols, headers, pages or example source files. You can omit any prefix from the symbol or file path. + Search for symbols, directories, files, pages or modules. You can omit any + prefix from the symbol or file path; adding a : or / + suffix lists all members of given symbol or directory. Navigate through the + list using ↓ and + ↑, press + Enter to go.
Sorry, nothing was found.
diff --git a/doxygen/test/layout_search_binary/Doxyfile b/doxygen/test/layout_search_binary/Doxyfile index ac4ebd4d..546e9ea4 100644 --- a/doxygen/test/layout_search_binary/Doxyfile +++ b/doxygen/test/layout_search_binary/Doxyfile @@ -5,3 +5,4 @@ M_THEME_COLOR = M_LINKS_NAVBAR1 = M_LINKS_NAVBAR2 = M_SEARCH_DOWNLOAD_BINARY = YES +M_SEARCH_HELP = "Halp." diff --git a/doxygen/test/layout_search_binary/index.html b/doxygen/test/layout_search_binary/index.html index d779083b..c486e7a8 100644 --- a/doxygen/test/layout_search_binary/index.html +++ b/doxygen/test/layout_search_binary/index.html @@ -57,7 +57,7 @@
- Search for symbols, headers, pages or example source files. You can omit any prefix from the symbol or file path. + Halp.
Sorry, nothing was found.
diff --git a/doxygen/test/test_doxyfile.py b/doxygen/test/test_doxyfile.py index df7404bb..3cb8e273 100644 --- a/doxygen/test/test_doxyfile.py +++ b/doxygen/test/test_doxyfile.py @@ -51,8 +51,13 @@ class Doxyfile(unittest.TestCase): 'M_SEARCH_DISABLED': False, 'M_SEARCH_DOWNLOAD_BINARY': False, 'M_SEARCH_EXTERNAL_URL': '', - 'M_SEARCH_HELP': 'Search for symbols, headers, pages or example source files. ' - 'You can omit any prefix from the symbol or file path.', + 'M_SEARCH_HELP': +"""Search for symbols, directories, files, pages or modules. You can omit any +prefix from the symbol or file path; adding a : or / +suffix lists all members of given symbol or directory. Navigate through the +list using ↓ and +↑, press +Enter to go.""", 'M_THEME_COLOR': '#22272e', 'OUTPUT_DIRECTORY': '', 'PROJECT_BRIEF': 'is cool', -- 2.30.2