mirror of
https://github.com/Kitware/CMake.git
synced 2025-12-30 10:20:56 -06:00
CheckPrototypeDefinition: Add intro code block
- Added intro code block showing how to include this module. - Used word "command" instead of "function". - Added a rubric title for variables that affect the check. - Synced module docs.
This commit is contained in:
@@ -5,10 +5,24 @@
|
||||
CheckPrototypeDefinition
|
||||
------------------------
|
||||
|
||||
Check if a ``C`` function has the expected prototype.
|
||||
This module provides a command to check if a C function has the expected
|
||||
prototype.
|
||||
|
||||
Load this module in a CMake project with:
|
||||
|
||||
.. code-block:: cmake
|
||||
|
||||
include(CheckPrototypeDefinition)
|
||||
|
||||
Commands
|
||||
^^^^^^^^
|
||||
|
||||
This module provides the following command:
|
||||
|
||||
.. command:: check_prototype_definition
|
||||
|
||||
Checks if a C function has the expected prototype:
|
||||
|
||||
.. code-block:: cmake
|
||||
|
||||
check_prototype_definition(<function> <prototype> <return> <headers> <variable>)
|
||||
@@ -41,8 +55,10 @@ Check if a ``C`` function has the expected prototype.
|
||||
<prototype> { return <return>; }
|
||||
int main(...) { ...<function>()... }
|
||||
|
||||
The following variables may be set before calling this function to modify
|
||||
the way the check is run:
|
||||
.. rubric:: Variables Affecting the Check
|
||||
|
||||
The following variables may be set before calling this command to modify
|
||||
the way the check is run:
|
||||
|
||||
.. include:: /module/include/CMAKE_REQUIRED_FLAGS.rst
|
||||
|
||||
|
||||
Reference in New Issue
Block a user