Add documentation to the function

Signed-off-by: Alexis Paques <[email protected]>
ros2 · Oct 19, 2022 · bd2bbde · bd2bbde
1 parent 25839ff
commit bd2bbde
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/cmake/Modules/CheckCrossCompilingSoabi.cmake b/cmake/Modules/CheckCrossCompilingSoabi.cmake
@@ -12,6 +12,16 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+###############################################################################
+#
+# CheckCrossCompilingSoabi function will exit the compilation early if we
+#   defined a CMAKE_SYSROOT but not the PYTHON_SOABI.
+#
+# Example usage:
+#
+#   CheckCrossCompilingSoabi()
+#
+###############################################################################
 function(CheckCrossCompilingSoabi)
   set(_python_code
     "from sysconfig import get_config_var"