Add comments for nnfw_find_package (#4700)

* Add comments for nnfw_find_package

This will add some example comments for nnfw_find_package in CMakeLists.txt file

Signed-off-by: SaeHie Park <saehie.park@samsung.com>
* apply comments

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 1d385f5..77a0c0b 100644 (file)
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -8,6 +8,13 @@ macro(nnfw_include PREFIX)
   include("${CMAKE_SOURCE_DIR}/cmake/modules/${PREFIX}.cmake")
 endmacro(nnfw_include)
 
+# 'find_package()' wrapper to find in cmake/packages folder
+#
+# Example:
+#  nnfw_find_package(Boost): Load settings from 'BoostConfig.cmake' file
+#    - this may drop warnings like "-- Could NOT find Boost (missing: Boost_DIR)
+#  nnfw_find_package(Boost QUIET): Load settings silently, without warnings
+#  nnfw_find_package(Boost REQUIRED): Load settings but stop with error when failed
 macro(nnfw_find_package PREFIX)
   find_package(${PREFIX} CONFIG NO_DEFAULT_PATH PATHS ${CMAKE_SOURCE_DIR}/cmake/packages ${ARGN})
 endmacro(nnfw_find_package)