diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/markdown/snippets/file-full-path.md | 7 | ||||
| -rw-r--r-- | docs/yaml/objects/file.yaml | 12 |
2 files changed, 18 insertions, 1 deletions
diff --git a/docs/markdown/snippets/file-full-path.md b/docs/markdown/snippets/file-full-path.md new file mode 100644 index 000000000..fbb8e548d --- /dev/null +++ b/docs/markdown/snippets/file-full-path.md @@ -0,0 +1,7 @@ +## File object now has `full_path()` method + +Returns a full path pointing to the file. This is useful for printing the path +with e.g [[message]] function for debugging purpose. + +**NOTE:** In most cases using the object itself will do the same job +as this and will also allow Meson to setup dependencies correctly. diff --git a/docs/yaml/objects/file.yaml b/docs/yaml/objects/file.yaml index 6aa0b85ce..5d2ad3053 100644 --- a/docs/yaml/objects/file.yaml +++ b/docs/yaml/objects/file.yaml @@ -1,3 +1,13 @@ name: file long_name: File -description: Opaque object that stores the path to an existing file +description: Object that stores the path to an existing file + +methods: +- name: full_path + returns: str + since: 1.4.0 + description: | + Returns a full path pointing to the file. This is useful for printing the + path with e.g [[message]] function for debugging purpose. + **NOTE:** In most cases using the object itself will do the same job + as this and will also allow Meson to setup dependencies correctly. |