diff options
| author | Eli Schwartz <eschwartz@archlinux.org> | 2022-06-22 17:50:33 -0400 |
|---|---|---|
| committer | Eli Schwartz <eschwartz@archlinux.org> | 2022-06-27 18:29:48 -0400 |
| commit | 21493fe5c6a43e34407d43f43fa9006c126d5554 (patch) | |
| tree | bd9db54a479def962f9a30f6fb2c9c28edbe5634 /docs | |
| parent | 8ef39090864bd6f14a9b628079840a411b129037 (diff) | |
| download | meson-21493fe5c6a43e34407d43f43fa9006c126d5554.zip meson-21493fe5c6a43e34407d43f43fa9006c126d5554.tar.gz meson-21493fe5c6a43e34407d43f43fa9006c126d5554.tar.bz2 | |
docs: correctly classify module methods as a method, not a function
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/markdown/CMake-module.md | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/markdown/CMake-module.md b/docs/markdown/CMake-module.md index 813a1c0..5fc5646 100644 --- a/docs/markdown/CMake-module.md +++ b/docs/markdown/CMake-module.md @@ -117,7 +117,7 @@ reference of all supported functions. The CMake configuration options object is very similar to the [[@cfg_data]] object] object returned by [[configuration_data]]. It -is generated by the `subproject_options` function +is generated by the `subproject_options` method. All configuration options have to be set *before* the subproject is configured and must be passed to the `subproject` method via the @@ -131,7 +131,7 @@ together with the `options` kwarg. ### `subproject` object -This object is returned by the `subproject` function described above +This object is returned by the `subproject` method described above and supports the following methods: - `dependency(target)` returns a dependency object for any CMake target. The @@ -139,7 +139,7 @@ and supports the following methods: returned dependency object similar to the same kwarg in the [[dependency]] function. - `include_directories(target)` returns a Meson [[@inc]] - object for the specified target. Using this function is not necessary + object for the specified target. Using this method is not necessary if the dependency object is used. - `target(target)` returns the raw build target. - `target_type(target)` returns the type of the target as a string @@ -152,8 +152,8 @@ and supports the following methods: ### `cmake options` object -This object is returned by the `subproject_options()` function and -consumed by the `options` kwarg of the `subproject` function. The +This object is returned by the `subproject_options()` method and +consumed by the `options` kwarg of the `subproject` method. The following methods are supported: - `add_cmake_defines({'opt1': val1, ...})` add additional CMake commandline defines @@ -225,7 +225,7 @@ specification](Machine-files.md). ### cmake.write_basic_package_version_file() -This function is the equivalent of the corresponding [CMake +This method is the equivalent of the corresponding [CMake function](https://cmake.org/cmake/help/latest/module/CMakePackageConfigHelpers.html#command:write_basic_package_version_file), it generates a `name` package version file. @@ -250,7 +250,7 @@ cmake.write_basic_package_version_file(name: 'myProject', version: '1.0.0') ### cmake.configure_package_config_file() -This function is the equivalent of the corresponding [CMake +This method is the equivalent of the corresponding [CMake function](https://cmake.org/cmake/help/v3.11/module/CMakePackageConfigHelpers.html#generating-a-package-configuration-file), it generates a `name` package configuration file from the `input` template file. Just like the cmake function in this file the |