From 8af95a27267e34579bd504932db2ba99c010690e Mon Sep 17 00:00:00 2001 From: Robert Knight Date: Tue, 30 Aug 2011 15:58:07 +0100 Subject: [PATCH] Update the documentation for the GenerateCppResourceFile module --- cmake/modules/GenerateCppResourceFile.cmake | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/cmake/modules/GenerateCppResourceFile.cmake b/cmake/modules/GenerateCppResourceFile.cmake index 3f830b2..c74917b 100644 --- a/cmake/modules/GenerateCppResourceFile.cmake +++ b/cmake/modules/GenerateCppResourceFile.cmake @@ -5,14 +5,17 @@ # Currently only implemented for Unix. Requires the 'xxd' # tool to be installed. # -# INPUT_FILE : The name of the binary data file to be converted into a C++ -# source file. +# TARGET_NAME : The name of the target to generate # -# CPP_FILE : The path of the C++ source file to be generated. -# See the documentation for xxd for information on -# the structure of the generated source file. +# INPUT_DIR : The directory containing the input binary data file # -# INPUT_FILE_TARGET : The name of the target which generates INPUT_FILE +# INPUT_FILE : The name of the binary data file in ${INPUT_DIR} to be converted into a C++ +# source file. The name of the input file will be used as the basis for the +# symbols in the generated C++ file referring to the data buffer and its length. +# +# CPP_FILE : The path of the C++ source file to be generated. +# See the documentation for xxd for information on +# the structure of the generated source file. # function (generate_cpp_resource_file TARGET_NAME INPUT_DIR INPUT_FILE CPP_FILE) add_custom_command(OUTPUT ${CPP_FILE} COMMAND cd ${INPUT_DIR} && xxd -i ${INPUT_FILE} ${CPP_FILE}