File: CMakeBuiltinFunctionsDocumentation.cmake

package info (click to toggle)
dune-common 2.10.0-4
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 5,804 kB
  • sloc: cpp: 52,256; python: 3,979; sh: 1,658; makefile: 17
file content (86 lines) | stat: -rw-r--r-- 2,179 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
# SPDX-FileCopyrightInfo: Copyright © DUNE Project contributors, see file LICENSE.md in module root
# SPDX-License-Identifier: LicenseRef-GPL-2.0-only-with-DUNE-exception

# This modules contains only documentation for CMake builtins.
# This is necessary to have an complete API documentation.
#
# .. cmake_function:: add_subdirectory
#
#    .. cmake_param:: dir
#       :single:
#       :positional:
#       :required:
#
#       The :code:`CMakeLists.txt` file from this subdirectory
#       will be executed next.
#
#    .. cmake_param:: EXCLUDE_FROM_ALL
#       :option:
#
#       Whether targets added in this subdirectory should be built
#       during :code:`make all`.
#
#    This is a cmake builtin command.
#    For detailed information, check the cmake documentation:
#
#    ::
#
#       cmake --help-command add_subdirectory
#
# .. cmake_function:: install
#
#    Define installation rules to customize the behaviour of :code:`make install`.
#
#    This is a cmake builtin command.
#    For detailed information, check the cmake documentation:
#
#    ::
#
#       cmake --help-command install
#
# .. cmake_function:: add_executable
#
#    Adds an executable to the project.
#
#    This is a cmake builtin command.
#    For detailed information, check the cmake documentation:
#
#    ::
#
#       cmake --help-command add_executable
#
# .. cmake_variable:: CMAKE_<LANG>_COMPILER
#
#    Set the compiler for the language LANG.
#    LANG is in our case out of C, CXX.
#
#    This is a cmake builtin variable.
#    For detailed information, check the cmake documentation:
#
#    ::
#
#       cmake --help-variable CMAKE_\<LANG\>_COMPILER
#
# .. cmake_variable:: CMAKE_<LANG>_FLAGS
#
#    Set the compile flags for the language LANG.
#    LANG is in our case out of C, CXX.
#
#    This is a cmake builtin variable.
#    For detailed information, check the cmake documentation:
#
#    ::
#
#       cmake --help-variable CMAKE_\<LANG\>_FLAGS
#
# .. cmake_function:: find_package
#
#    Look for an external package.
#
#    This is a cmake builtin command.
#    For detailed information, check the cmake documentation:
#
#    ::
#
#       cmake --help-command find_package
#