diff options
Diffstat (limited to 'docs/yaml/objects/external_program.yaml')
| -rw-r--r-- | docs/yaml/objects/external_program.yaml | 39 |
1 files changed, 38 insertions, 1 deletions
diff --git a/docs/yaml/objects/external_program.yaml b/docs/yaml/objects/external_program.yaml index d0e476f5d..02bf48f6b 100644 --- a/docs/yaml/objects/external_program.yaml +++ b/docs/yaml/objects/external_program.yaml @@ -1,3 +1,40 @@ name: external_program long_name: External program -description: TODO +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') + ``` |