Kitware/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2025-05-08 22:37:04 +08:00
Code Issues Projects Releases Wiki Activity

FindHTMLHelp: Update documentation

Browse Source
This commit is contained in:
Peter Kokot 2025-03-23 22:34:18 +01:00
parent 5cc08a4563
commit 6a083a812b
No known key found for this signature in database
GPG Key ID: A94800907AA79B36
1 changed files with 30 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
Modules/FindHTMLHelp.cmake
View File

@ -5,15 +5,39 @@
FindHTMLHelp FindHTMLHelp
------------ ------------
This module looks for Microsoft HTML Help Compiler This module finds the Microsoft HTML Help Compiler and its API. It is part of
the HTML Help Workshop.
It defines: .. note::
:: HTML Help Workshop is in maintenance mode only and is considered deprecated.
For modern documentation, consider alternatives such as Microsoft Help Viewer
for producing ``.mshc`` files or web-based documentation tools.
HTML_HELP_COMPILER : full path to the Compiler (hhc.exe) Cache Variables
HTML_HELP_INCLUDE_PATH : include path to the API (htmlhelp.h) ^^^^^^^^^^^^^^^
HTML_HELP_LIBRARY : full path to the library (htmlhelp.lib)
This module may set the following cache variables:
``HTML_HELP_COMPILER``
Full path to the HTML Help Compiler (``hhc.exe``), used to compile ``.chm``
files.
``HTML_HELP_INCLUDE_PATH``
Directory containing ``htmlhelp.h``, required for applications integrating the
HTML Help API.
``HTML_HELP_LIBRARY``
Full path to ``htmlhelp.lib`` library, required for linking applications that
use the HTML Help API.
Examples
^^^^^^^^
Finding HTML Help Compiler:
.. code-block:: cmake
find_package(HTMLHelp)
message(STATUS "HTML Help Compiler found at: ${HTML_HELP_COMPILER}")
#]=======================================================================] #]=======================================================================]
if(WIN32) if(WIN32)