@@ -194,49 +194,49 @@ size_t path_basedir(char *path);
194194
195195/**
196196 * path_parent_dir:
197- * @path : path
198- * @len : length of @path
197+ * @s : path
198+ * @len : size of buffer
199199 *
200200 * Extracts parent directory by mutating path.
201201 * Assumes that path is a directory. Keeps trailing '/'.
202202 * If the path was already at the root directory, returns empty string
203203 **/
204- size_t path_parent_dir (char * path , size_t len );
204+ size_t path_parent_dir (char * s , size_t len );
205205
206206/**
207207 * path_resolve_realpath:
208- * @buf : input and output buffer for path
208+ * @s : input and output buffer for path
209209 * @size : size of buffer
210210 * @resolve_symlinks : whether to resolve symlinks or not
211211 *
212212 * Resolves use of ".", "..", multiple slashes etc in absolute paths.
213213 *
214214 * Relative paths are rebased on the current working dir.
215215 *
216- * @return @buf if successful, NULL otherwise.
216+ * @return @s if successful, NULL otherwise.
217217 * Note: Not implemented on consoles
218218 * Note: Symlinks are only resolved on Unix-likes
219219 * Note: The current working dir might not be what you expect,
220220 * e.g. on Android it is "/"
221221 * Use of fill_pathname_resolve_relative() should be preferred
222222 **/
223- char * path_resolve_realpath (char * buf , size_t len , bool resolve_symlinks );
223+ char * path_resolve_realpath (char * s , size_t len , bool resolve_symlinks );
224224
225225/**
226226 * path_relative_to:
227- * @out : buffer to write the relative path to
227+ * @s : buffer to write the relative path to
228228 * @path : path to be expressed relatively
229229 * @base : relative to this
230- * @size : size of output buffer
230+ * @len : size of output buffer
231231 *
232- * Turns @path into a path relative to @base and writes it to @out .
232+ * Turns @path into a path relative to @base and writes it to @s .
233233 *
234234 * @base is assumed to be a base directory, i.e. a path ending with '/' or '\'.
235235 * Both @path and @base are assumed to be absolute paths without "." or "..".
236236 *
237237 * E.g. path /a/b/e/f.cgp with base /a/b/c/d/ turns into ../../e/f.cgp
238238 *
239- * @return Length of the string copied into @out
239+ * @return Length of the string copied into @s
240240 **/
241241size_t path_relative_to (char * s , const char * path , const char * base ,
242242 size_t len );
@@ -277,7 +277,7 @@ bool path_is_absolute(const char *path);
277277 * - calls strrchr
278278 * - calls strlcat
279279 *
280- * @return Length of the string copied into @out
280+ * @return Length of the string copied into @s
281281 */
282282size_t fill_pathname (char * s , const char * in_path ,
283283 const char * replace , size_t len );
@@ -371,23 +371,23 @@ size_t fill_pathname_dir(char *s, const char *in_basename,
371371 * fill_pathname_base:
372372 * @s : output path
373373 * @in_path : input path
374- * @size : size of output path
374+ * @len : size of output path
375375 *
376376 * Copies basename of @in_path into @s.
377377 *
378378 * Hidden non-leaf function cost:
379379 * - Calls path_basename()
380380 * - Calls strlcpy
381381 *
382- * @return length of the string copied into @out
382+ * @return length of the string copied into @s
383383 **/
384384size_t fill_pathname_base (char * s , const char * in_path , size_t len );
385385
386386/**
387387 * fill_pathname_basedir:
388388 * @s : output directory
389389 * @in_path : input path
390- * @size : size of output directory
390+ * @len : size of output directory
391391 *
392392 * Copies base directory of @in_path into @s.
393393 * If in_path is a path without any slashes (relative current directory),
@@ -405,7 +405,7 @@ size_t fill_pathname_basedir(char *s, const char *in_path, size_t len);
405405 * @in_dir : input directory
406406 * @len : size of @s
407407 *
408- * Copies only the parent directory name of @in_dir into @out_dir .
408+ * Copies only the parent directory name of @in_dir into @s .
409409 * The two buffers must not overlap. Removes trailing '/'.
410410 *
411411 * Hidden non-leaf function cost:
@@ -419,17 +419,17 @@ size_t fill_pathname_parent_dir_name(char *s,
419419
420420/**
421421 * fill_pathname_parent_dir:
422- * @out_dir : output directory
422+ * @s : output directory
423423 * @in_dir : input directory
424- * @size : size of output directory
424+ * @len : size of output directory
425425 *
426- * Copies parent directory of @in_dir into @out_dir .
426+ * Copies parent directory of @in_dir into @s .
427427 * Assumes @in_dir is a directory. Keeps trailing '/'.
428- * If the path was already at the root directory, @out_dir will be an empty string.
428+ * If the path was already at the root directory, @s will be an empty string.
429429 *
430430 * Hidden non-leaf function cost:
431- * - Can call strlcpy if (@out_dir != @in_dir)
432- * - Calls strlen if (@out_dir == @in_dir)
431+ * - Can call strlcpy if (@s != @in_dir)
432+ * - Calls strlen if (@s == @in_dir)
433433 * - Calls path_parent_dir()
434434 *
435435 * @return Length of the string copied into @s
@@ -442,7 +442,7 @@ size_t fill_pathname_parent_dir(char *s,
442442 * @s : output path
443443 * @in_refpath : input reference path
444444 * @in_path : input path
445- * @size : size of @s
445+ * @len : size of @s
446446 *
447447 * Joins basedir of @in_refpath together with @in_path.
448448 * If @in_path is an absolute path, s = in_path.
@@ -457,7 +457,7 @@ void fill_pathname_resolve_relative(char *s, const char *in_refpath,
457457 * @s : output path
458458 * @dir : directory
459459 * @path : path
460- * @size : size of output path
460+ * @len : size of output path
461461 *
462462 * Joins a directory (@dir) and path (@path) together.
463463 * Makes sure not to get two consecutive slashes
@@ -480,7 +480,7 @@ size_t fill_pathname_join(char *s, const char *dir,
480480 * @s : output path
481481 * @dir : directory. Cannot be identical to @s
482482 * @path : path
483- * @size : size of output path
483+ * @len : size of output path
484484 *
485485 *
486486 * Specialized version of fill_pathname_join.
@@ -510,7 +510,7 @@ size_t fill_pathname_join_special_ext(char *s,
510510 * @dir : directory
511511 * @path : path
512512 * @delim : delimiter
513- * @size : size of output path
513+ * @len : size of output path
514514 *
515515 * Joins a directory (@dir) and path (@path) together
516516 * using the given delimiter (@delim).
@@ -548,7 +548,7 @@ size_t fill_pathname_abbreviated_or_relative(char *s,
548548 * sanitize_path_part:
549549 *
550550 * @path_part : directory or filename
551- * @size : length of path_part
551+ * @len : length of path_part
552552 *
553553 * Takes single part of a path eg. single filename
554554 * or directory, and removes any special chars that are
@@ -621,8 +621,8 @@ void path_basedir_wrapper(char *s);
621621
622622/**
623623 * fill_pathname_slash:
624- * @path : path
625- * @size : size of path
624+ * @s : path
625+ * @len : size of path
626626 *
627627 * Assumes path is a directory. Appends a slash
628628 * if not already there.
0 commit comments