mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-05-01 03:29:18 -05:00
Code Issues Packages Projects Releases Wiki Activity

FindMatlab: Fix multi-signature function documentation anchors

Browse Source 
Fix use of the `signature::` directive by commit ae558b9ad0 (FindMatlab:
Support REGISTRY_VIEW, 2024-02-08, v3.30.0-rc1~528^2).  The directive
was created for use inside `Help/command/*.rst` documents.  Using it
in module documentation requires explicit anchors.
This commit is contained in:
Brad King
2025-01-16 14:21:58 -05:00
parent ba86b3d841
commit 6e21dcc0ee
1 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Modules/FindMatlab.cmake
+7 -5
View File
@@ -461,27 +461,29 @@ endmacro()
.. command:: matlab_extract_all_installed_versions_from_registry .. command:: matlab_extract_all_installed_versions_from_registry
This function parses the Windows registry and finds the Matlab versions that This function parses the Windows registry and finds the Matlab versions that
are installed. The found versions are stored in ``matlab_versions``. are installed. The found versions are stored in a given ``<versions-var>``.
.. signature:: .. signature::
matlab_extract_all_installed_versions_from_registry(matlab_versions matlab_extract_all_installed_versions_from_registry(<versions-var>
[REGISTRY_VIEW view]) [REGISTRY_VIEW view])
:target: matlab_extract_all_installed_versions_from_registry-keyword
.. versionadded:: 3.30 .. versionadded:: 3.30
* Output: ``matlab_versions`` is a list of all the versions of Matlab found * Output: ``<versions-var>`` is a list of all the versions of Matlab found
* Input: ``REGISTRY_VIEW`` Optional registry view to use for registry * Input: ``REGISTRY_VIEW`` Optional registry view to use for registry
interaction. The argument is passed (or omitted) to interaction. The argument is passed (or omitted) to
:command:`cmake_host_system_information` without further checks or :command:`cmake_host_system_information` without further checks or
modification. modification.
.. signature:: .. signature::
matlab_extract_all_installed_versions_from_registry(win64 matlab_versions) matlab_extract_all_installed_versions_from_registry(<win64> <versions-var>)
:target: matlab_extract_all_installed_versions_from_registry-positional
* Input: ``win64`` is a boolean to search for the 64 bit version of * Input: ``win64`` is a boolean to search for the 64 bit version of
Matlab. Set to ``ON`` to use the 64bit registry view or ``OFF`` to use the Matlab. Set to ``ON`` to use the 64bit registry view or ``OFF`` to use the
32bit registry view. If finer control is needed, see signature above. 32bit registry view. If finer control is needed, see signature above.
* Output: ``matlab_versions`` is a list of all the versions of Matlab found * Output: ``<versions-var>`` is a list of all the versions of Matlab found
The returned list contains all versions under The returned list contains all versions under
``HKLM\SOFTWARE\Mathworks\MATLAB``, ``HKLM\SOFTWARE\Mathworks\MATLAB``,