Rename PBD::get_files_in_directory to just PBD::get_files, change parameter order and fix docs

This commit is contained in:
Tim Mayberry 2014-06-22 17:39:06 +10:00 committed by Paul Davis
parent b668c53c5c
commit 849adaf7e5
2 changed files with 5 additions and 6 deletions

View file

@ -177,7 +177,7 @@ get_paths (vector<string>& result,
} }
void void
get_files_in_directory (const std::string& directory_path, vector<string>& result) get_files (vector<string>& result, const std::string& directory_path)
{ {
return get_paths (result, directory_path, true, false); return get_paths (result, directory_path, true, false);
} }

View file

@ -49,15 +49,14 @@ get_paths (std::vector<std::string>& result,
/** /**
* Get a list of files in a directory. * Get a list of files in a directory.
* @note You must join path with result to get the absolute path * @note paths in result will be absolute.
* to the file.
* *
* @param path An Absolute path to a directory * @param path An Absolute path to a directory
* @param result A vector of filenames. * @param result A vector of paths to files.
*/ */
LIBPBD_API void LIBPBD_API void
get_files_in_directory (const std::string& path, get_files (std::vector<std::string>& result,
std::vector<std::string>& result); const std::string& path);
/** /**
* Takes a Searchpath and returns all the files contained in the * Takes a Searchpath and returns all the files contained in the