Merge pull request #8960 from mensinda/yamlDoc

Reference Manual 2.0

1 files changed, 40 insertions, 0 deletions

diff --git a/docs/yaml/objects/external_program.yaml b/docs/yaml/objects/external_program.yaml
new file mode 100644
index 000000000..02bf48f6b
--- /dev/null
+++ b/docs/yaml/objects/external_program.yaml
@@ -0,0 +1,40 @@
+name: external_program
+long_name: External program
+description: Opaque object representing an external program
+
+methods:
+- name: found
+  returns: bool
+  description: Returns whether the executable was found.
+
+- name: path
+  returns: str
+  deprecated: 0.55.0
+  description: |
+    *Deprecated:* Use [[external_program.full_path]] instead.
+
+    Returns a string pointing to the script or executable.
+
+    **NOTE:** You should not need to use this method. Passing the object itself
+    should work in all cases.
+
+    For example:
+
+    ```meson
+    run_command(find_program('foo'), 'arg1', 'arg2')
+    ```
+
+- name: full_path
+  returns: str
+  since: 0.55.0
+  description: |
+    Returns a string pointing to the script or executable.
+
+    **NOTE:** You should not need to use this method. Passing the object itself
+    should work in all cases.
+
+    For example:
+
+    ```meson
+    run_command(find_program('foo'), 'arg1', 'arg2')
+    ```