mirror of
https://github.com/Kitware/CMake.git
synced 2026-02-21 22:50:26 -06:00
Help: Convert remaining modules to block-style comments
This commit is contained in:
committed by
Kyle Edwards
parent
7115aa6c22
commit
df4ed1e9ff
@@ -1,42 +1,43 @@
|
||||
# Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
||||
# file Copyright.txt or https://cmake.org/licensing for details.
|
||||
|
||||
#.rst:
|
||||
# CheckStructHasMember
|
||||
# --------------------
|
||||
#
|
||||
# Check if the given struct or class has the specified member variable
|
||||
#
|
||||
# ::
|
||||
#
|
||||
# CHECK_STRUCT_HAS_MEMBER(<struct> <member> <header> <variable>
|
||||
# [LANGUAGE <language>])
|
||||
#
|
||||
# ::
|
||||
#
|
||||
# <struct> - the name of the struct or class you are interested in
|
||||
# <member> - the member which existence you want to check
|
||||
# <header> - the header(s) where the prototype should be declared
|
||||
# <variable> - variable to store the result
|
||||
# <language> - the compiler to use (C or CXX)
|
||||
#
|
||||
#
|
||||
#
|
||||
# The following variables may be set before calling this macro to modify
|
||||
# the way the check is run:
|
||||
#
|
||||
# ::
|
||||
#
|
||||
# CMAKE_REQUIRED_FLAGS = string of compile command line flags
|
||||
# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar)
|
||||
# CMAKE_REQUIRED_INCLUDES = list of include directories
|
||||
# CMAKE_REQUIRED_LIBRARIES = list of libraries to link
|
||||
# CMAKE_REQUIRED_QUIET = execute quietly without messages
|
||||
#
|
||||
#
|
||||
#
|
||||
# Example: CHECK_STRUCT_HAS_MEMBER("struct timeval" tv_sec sys/select.h
|
||||
# HAVE_TIMEVAL_TV_SEC LANGUAGE C)
|
||||
#[=======================================================================[.rst:
|
||||
CheckStructHasMember
|
||||
--------------------
|
||||
|
||||
Check if the given struct or class has the specified member variable
|
||||
|
||||
::
|
||||
|
||||
CHECK_STRUCT_HAS_MEMBER(<struct> <member> <header> <variable>
|
||||
[LANGUAGE <language>])
|
||||
|
||||
::
|
||||
|
||||
<struct> - the name of the struct or class you are interested in
|
||||
<member> - the member which existence you want to check
|
||||
<header> - the header(s) where the prototype should be declared
|
||||
<variable> - variable to store the result
|
||||
<language> - the compiler to use (C or CXX)
|
||||
|
||||
|
||||
|
||||
The following variables may be set before calling this macro to modify
|
||||
the way the check is run:
|
||||
|
||||
::
|
||||
|
||||
CMAKE_REQUIRED_FLAGS = string of compile command line flags
|
||||
CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar)
|
||||
CMAKE_REQUIRED_INCLUDES = list of include directories
|
||||
CMAKE_REQUIRED_LIBRARIES = list of libraries to link
|
||||
CMAKE_REQUIRED_QUIET = execute quietly without messages
|
||||
|
||||
|
||||
|
||||
Example: CHECK_STRUCT_HAS_MEMBER("struct timeval" tv_sec sys/select.h
|
||||
HAVE_TIMEVAL_TV_SEC LANGUAGE C)
|
||||
#]=======================================================================]
|
||||
|
||||
include_guard(GLOBAL)
|
||||
include(CheckCSourceCompiles)
|
||||
|
||||
Reference in New Issue
Block a user