summaryrefslogtreecommitdiffstats
path: root/Source/cmDocumentation.h
diff options
context:
space:
mode:
authorMartin Duffy <martin.duffy@kitware.com>2023-08-31 17:08:06 (GMT)
committerMartin Duffy <martin.duffy@kitware.com>2023-09-27 22:01:12 (GMT)
commit4e503209788159bba7eda427014e7dd58cf73b06 (patch)
tree2ed8be3f5a88f87f3659ea82fd108f08bd510eba /Source/cmDocumentation.h
parent72beefa91b7d6ea6eeffaf0977219e9e3fc4943d (diff)
downloadCMake-4e503209788159bba7eda427014e7dd58cf73b06.zip
CMake-4e503209788159bba7eda427014e7dd58cf73b06.tar.gz
CMake-4e503209788159bba7eda427014e7dd58cf73b06.tar.bz2
Help: Allow help for arbitrary keywords
Changes `cmake --help [arg]` to search `Help/*/` instead of `Help/command/` Allows editors to easily display manual for `<cword>`
Diffstat (limited to 'Source/cmDocumentation.h')
-rw-r--r--Source/cmDocumentation.h3
1 files changed, 3 insertions, 0 deletions
diff --git a/Source/cmDocumentation.h b/Source/cmDocumentation.h
index 6930986..3e6bdfb 100644
--- a/Source/cmDocumentation.h
+++ b/Source/cmDocumentation.h
@@ -34,6 +34,7 @@ public:
ListVariables,
ListPolicies,
ListGenerators,
+ OneArbitrary,
OneManual,
OneCommand,
OneModule,
@@ -118,6 +119,7 @@ private:
bool PrintUsage(std::ostream& os);
bool PrintHelp(std::ostream& os);
bool PrintHelpFull(std::ostream& os);
+ bool PrintHelpOneArbitrary(std::ostream& os);
bool PrintHelpOneManual(std::ostream& os);
bool PrintHelpOneCommand(std::ostream& os);
bool PrintHelpOneModule(std::ostream& os);
@@ -154,4 +156,5 @@ private:
cmDocumentationFormatter Formatter;
static void WarnFormFromFilename(RequestedHelpItem& request, bool& result);
+ static std::string GeneralizeKeyword(std::string word);
};