Improve method documentation

This commit is contained in:
nsubiron 2019-03-27 14:06:17 +01:00
parent e8e13239c8
commit 918109f010
2 changed files with 7 additions and 1 deletions

View File

@ -35,7 +35,7 @@ namespace carla {
const std::string &wildcard_pattern) {
fs::path root(folder_path);
if (!fs::exists(root) || !fs::is_directory(root)) {
throw_exception(std::invalid_argument(folder_path + ": not such folder"));
throw_exception(std::invalid_argument(folder_path + ": no such folder"));
}
std::vector<std::string> results;

View File

@ -26,6 +26,12 @@ namespace carla {
std::string &filepath,
const std::string &default_extension = "");
/// List (not recursively) regular files at @a folder_path matching
/// @a wildcard_pattern.
///
/// @throw std::invalid_argument if folder does not exist.
///
/// @todo Do permission check.
static std::vector<std::string> ListFolder(
const std::string &folder_path,
const std::string &wildcard_pattern);