Mercurial > molko
diff cmake/MolkoBuildAssets.cmake @ 245:97f55f6b9593
doc: add CMake macros documentation
author | David Demelier <markand@malikania.fr> |
---|---|
date | Mon, 30 Nov 2020 10:54:59 +0100 |
parents | 71b3b7036de7 |
children |
line wrap: on
line diff
--- a/cmake/MolkoBuildAssets.cmake Mon Nov 30 09:48:52 2020 +0100 +++ b/cmake/MolkoBuildAssets.cmake Mon Nov 30 10:54:59 2020 +0100 @@ -17,24 +17,27 @@ # # -# molko_build_assets -# ------------------ -# -# Synopsis: -# -# molko_build_assets(assets outputs) +# # molko_build_assets # # Generate custom commands to convert assets into C header files using mlk-bcc. # The argument output will be set to contain every generated output so that the # caller can set them as source input and be generated before the target itself. # -# Example: +# ## Synopsis: # +# ```cmake +# molko_build_assets(assets outputs) +# ``` +# +# ## Example +# +# ```cmake # molko_build_assets(image.png outputs) # add_executable(main main.c ${outputs}) +# ``` # # Do not forget to add the CMake current binary directory -# ${CMAKE_CURRENT_BINARY_DIR} through the include flags of the given target. +# `${CMAKE_CURRENT_BINARY_DIR}` through the include flags of the given target. # # Each file is generated using the exact same file hierarchy as the input so # an input of foo/bar/baz.png will be generated as foo/bar/baz.h in the binary