Browse Source

Improve CMake utilities docstrings

Michael Ragazzon 10 months ago
parent
commit
8f3eb7f8a0
1 changed files with 3 additions and 1 deletions
  1. 3 1
      CMake/Utilities.cmake

+ 3 - 1
CMake/Utilities.cmake

@@ -43,6 +43,7 @@ endfunction()
 		- package_name: Name of the package to search for
 		- target_name: Name of the CMake target the project will link against
 		- success_message: Message to show when the target exists (optional)
+	Note: The name and signature of this function should match the macro in `RmlUiConfig.cmake.in`.
 ]]
 function(report_dependency_found package_name target_name)
 	set(message "")
@@ -61,7 +62,8 @@ endfunction()
 		- friendly_name: Friendly name of the dependency
 		- package_name: Name of the package to search for
 		- target_name: Name of the CMake target the project will link against
-		- success_message: Message to show when the target exists (optional)
+		- success_message [optional]: Message to show when the target exists
+	Note: The name and signature of this function should match the macro in `RmlUiConfig.cmake.in`.
 ]]
 function(report_dependency_found_or_error friendly_name package_name target_name)
 	if(NOT TARGET ${target_name})