Browse Source

Merge topic 'patch-CheckPrototypeDefinition'

20f4ef1f1b CheckPrototypeDefinition: Add intro code block

Acked-by: Kitware Robot <[email protected]>
Merge-request: !10794
Brad King 5 months ago
parent
commit
4882400b87
1 changed files with 19 additions and 3 deletions
  1. 19 3
      Modules/CheckPrototypeDefinition.cmake

+ 19 - 3
Modules/CheckPrototypeDefinition.cmake

@@ -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