github-mirror/cwalk
1
0 Fork 0
mirror of https://github.com/likle/cwalk.git synced 2026-10-28 09:44:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

better documentation of the return value in the normalize function #45

Browse Source
This commit is contained in:
Leonard Iklé committed 2024-02-07 20:06:05 +01:00
1 parent 982e86076e
commit f418404bf3
2 files changed
+5 -4
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/reference/cwk_path_normalize.md
+1 -1
View File
@@ -11,7 +11,7 @@ Creates a normalized version of the path.
size_t cwk_path_normalize(const char *path, char *buffer, size_t buffer_size);
```
This function creates a normalized version of the path within the specified buffer. This function will not write out more than the specified buffer can contain. However, the generated string is always null-terminated - even if not the whole path is written out. The function returns the total number of characters the complete buffer would have, even if it was not written out completely. The path may be the same memory address as the buffer.
This function creates a normalized version of the path within the specified buffer. This function will not write out more than the specified buffer can contain. However, the generated string is always null-terminated - even if not the whole path is written out. The returned value is the amount of characters which the resulting path would take if it was not truncated (excluding the null-terminating character). The path may be the same memory address as the buffer.
The following will be true for the normalized path:
* "../" will be resolved.