summaryrefslogtreecommitdiff
path: root/docs/yaml/modules
diff options
context:
space:
mode:
authorDaniel Mensinger <daniel@mensinger-ka.de>2021-08-21 16:27:56 +0200
committerDaniel Mensinger <daniel@mensinger-ka.de>2021-10-03 11:46:34 +0200
commit2b482e39a90fa1929e0fa4006861f4264f28adb2 (patch)
tree0af5ef229d25bef1b974445406fc3c9d28c0756f /docs/yaml/modules
parentad65a699f93a7659739287882ca27c58c564670b (diff)
downloadmeson-2b482e39a90fa1929e0fa4006861f4264f28adb2.tar.gz
docs: Add the YAML Reference manual
Diffstat (limited to 'docs/yaml/modules')
-rw-r--r--docs/yaml/modules/cmake/module.yaml8
-rw-r--r--docs/yaml/modules/cmake/options.yaml14
2 files changed, 22 insertions, 0 deletions
diff --git a/docs/yaml/modules/cmake/module.yaml b/docs/yaml/modules/cmake/module.yaml
new file mode 100644
index 000000000..1fa5064fb
--- /dev/null
+++ b/docs/yaml/modules/cmake/module.yaml
@@ -0,0 +1,8 @@
+name: cmake
+long_name: CMake module
+description: The CMake module
+
+methods:
+- name: subproject_options
+ description: Returns an empty `cmake_options` object.
+ returns: cmake_options
diff --git a/docs/yaml/modules/cmake/options.yaml b/docs/yaml/modules/cmake/options.yaml
new file mode 100644
index 000000000..d39132ce4
--- /dev/null
+++ b/docs/yaml/modules/cmake/options.yaml
@@ -0,0 +1,14 @@
+name: cmake_options
+long_name: CMake subproject options
+description: Central configuration object for CMake subprojects
+since: 0.55.0
+
+methods:
+- name: add_cmake_defines
+ returns: void
+ description: Add CMake defines (`-D<VAR>=<VAL>`) to the CMake commandline
+
+ varargs:
+ name: defines
+ description: A `key` `value` map of CMake defines to add (`-D<key>=<val>`)
+ type: dict[str]