disktidy: add a comment to the function

git-svn-id: svn://svn.rockbox.org/rockbox/trunk@28896 a1c6a512-1295-4272-9138-f99709370657
This commit is contained in:
Alexander Levin 2010-12-25 21:31:54 +00:00
parent 82daaae455
commit de317d46dc

View file

@ -228,7 +228,10 @@ void tidy_path_remove_entry(char *path, int old_path_length, int *path_length)
*path_length = old_path_length; *path_length = old_path_length;
} }
/* path is assumed to be array of size MAX_PATH */ /* Removes the directory specified by 'path'. This includes recursively
removing all files and directories in that directory.
path is assumed to be array of size MAX_PATH.
*/
enum tidy_return tidy_removedir(char *path, int *path_length) enum tidy_return tidy_removedir(char *path, int *path_length)
{ {
/* delete directory */ /* delete directory */