DOC: better documentaiton
This commit is contained in:
parent
35b529cc3e
commit
0a5b9db60b
@ -4,6 +4,10 @@
|
|||||||
# CHECK_FUNCTION_EXISTS - macro which checks if the function exists
|
# CHECK_FUNCTION_EXISTS - macro which checks if the function exists
|
||||||
# FUNCTION - the name of the function
|
# FUNCTION - the name of the function
|
||||||
# VARIABLE - variable to store the result
|
# VARIABLE - variable to store the result
|
||||||
|
#
|
||||||
|
# If CMAKE_REQUIRED_FLAGS is set then those flags will be passed into the
|
||||||
|
# compile of the program likewise if CMAKE_REQUIRED_LIBRARIES is set then
|
||||||
|
# those libraries will be linked against the test program
|
||||||
#
|
#
|
||||||
|
|
||||||
MACRO(CHECK_FUNCTION_EXISTS FUNCTION VARIABLE)
|
MACRO(CHECK_FUNCTION_EXISTS FUNCTION VARIABLE)
|
||||||
|
@ -5,7 +5,9 @@
|
|||||||
# INCLUDE - name of include file
|
# INCLUDE - name of include file
|
||||||
# VARIABLE - variable to return result
|
# VARIABLE - variable to return result
|
||||||
#
|
#
|
||||||
|
# an optional third argument is the CFlags to add to the compile line
|
||||||
|
# or you can use CMAKE_REQUIRED_FLAGS
|
||||||
|
#
|
||||||
MACRO(CHECK_INCLUDE_FILE INCLUDE VARIABLE)
|
MACRO(CHECK_INCLUDE_FILE INCLUDE VARIABLE)
|
||||||
IF("${VARIABLE}" MATCHES "^${VARIABLE}$")
|
IF("${VARIABLE}" MATCHES "^${VARIABLE}$")
|
||||||
SET(MACRO_CHECK_INCLUDE_FILE_FLAGS ${CMAKE_REQUIRED_FLAGS})
|
SET(MACRO_CHECK_INCLUDE_FILE_FLAGS ${CMAKE_REQUIRED_FLAGS})
|
||||||
|
@ -4,7 +4,8 @@
|
|||||||
# CHECK_INCLUDE_FILE - macro which checks the include file exists.
|
# CHECK_INCLUDE_FILE - macro which checks the include file exists.
|
||||||
# INCLUDE - name of include file
|
# INCLUDE - name of include file
|
||||||
# VARIABLE - variable to return result
|
# VARIABLE - variable to return result
|
||||||
# OPTIONAL - a third argument can be extra flags which are passed to the compiler
|
#
|
||||||
|
# a third argument can be passed containing extra flags for the compiler
|
||||||
#
|
#
|
||||||
|
|
||||||
MACRO(CHECK_INCLUDE_FILE_CXX INCLUDE VARIABLE)
|
MACRO(CHECK_INCLUDE_FILE_CXX INCLUDE VARIABLE)
|
||||||
|
@ -5,6 +5,9 @@
|
|||||||
# INCLUDE - list of files to include
|
# INCLUDE - list of files to include
|
||||||
# VARIABLE - variable to return result
|
# VARIABLE - variable to return result
|
||||||
#
|
#
|
||||||
|
# If CMAKE_REQUIRED_FLAGS is set then those flags will be passed into the
|
||||||
|
# compile of the program
|
||||||
|
|
||||||
|
|
||||||
MACRO(CHECK_INCLUDE_FILES INCLUDE VARIABLE)
|
MACRO(CHECK_INCLUDE_FILES INCLUDE VARIABLE)
|
||||||
IF("${VARIABLE}" MATCHES "^${VARIABLE}$")
|
IF("${VARIABLE}" MATCHES "^${VARIABLE}$")
|
||||||
|
@ -5,6 +5,10 @@
|
|||||||
# FUNCTION - the name of the function
|
# FUNCTION - the name of the function
|
||||||
# VARIABLE - variable to store the result
|
# VARIABLE - variable to store the result
|
||||||
#
|
#
|
||||||
|
# If CMAKE_REQUIRED_FLAGS is set then those flags will be passed into the
|
||||||
|
# compile of the program likewise if CMAKE_REQUIRED_LIBRARIES is set then
|
||||||
|
# those libraries will be linked against the test program
|
||||||
|
|
||||||
|
|
||||||
MACRO(CHECK_LIBRARY_EXISTS LIBRARY FUNCTION LOCATION VARIABLE)
|
MACRO(CHECK_LIBRARY_EXISTS LIBRARY FUNCTION LOCATION VARIABLE)
|
||||||
IF("${VARIABLE}" MATCHES "^${VARIABLE}$")
|
IF("${VARIABLE}" MATCHES "^${VARIABLE}$")
|
||||||
|
@ -6,6 +6,10 @@
|
|||||||
# FILES - include files to check
|
# FILES - include files to check
|
||||||
# VARIABLE - variable to return result
|
# VARIABLE - variable to return result
|
||||||
#
|
#
|
||||||
|
# If CMAKE_REQUIRED_FLAGS is set then those flags will be passed into the
|
||||||
|
# compile of the program likewise if CMAKE_REQUIRED_LIBRARIES is set then
|
||||||
|
# those libraries will be linked against the test program
|
||||||
|
|
||||||
|
|
||||||
MACRO(CHECK_SYMBOL_EXISTS SYMBOL FILES VARIABLE)
|
MACRO(CHECK_SYMBOL_EXISTS SYMBOL FILES VARIABLE)
|
||||||
IF("${VARIABLE}" MATCHES "^${VARIABLE}$")
|
IF("${VARIABLE}" MATCHES "^${VARIABLE}$")
|
||||||
|
@ -4,7 +4,12 @@
|
|||||||
# VAR - the name of the variable
|
# VAR - the name of the variable
|
||||||
# VARIABLE - variable to store the result
|
# VARIABLE - variable to store the result
|
||||||
#
|
#
|
||||||
|
# If CMAKE_REQUIRED_FLAGS is set then those flags will be passed into the
|
||||||
|
# compile of the program likewise if CMAKE_REQUIRED_LIBRARIES is set then
|
||||||
|
# those libraries will be linked against the test program
|
||||||
|
#
|
||||||
|
# only for C variables
|
||||||
|
#
|
||||||
MACRO(CHECK_VARIABLE_EXISTS VAR VARIABLE)
|
MACRO(CHECK_VARIABLE_EXISTS VAR VARIABLE)
|
||||||
IF("${VARIABLE}" MATCHES "^${VARIABLE}$")
|
IF("${VARIABLE}" MATCHES "^${VARIABLE}$")
|
||||||
SET(MACRO_CHECK_VARIABLE_DEFINITIONS
|
SET(MACRO_CHECK_VARIABLE_DEFINITIONS
|
||||||
|
Loading…
x
Reference in New Issue
Block a user