From ca0081e14b96eb6436ad349be2f2148520c16f38 Mon Sep 17 00:00:00 2001 From: Andreas Stöckel Date: Tue, 17 Feb 2015 01:05:32 +0100 Subject: Improved semantics of the return value of the autocomplete function: Empty return value explicitly means that the file does not exist at all. --- src/core/resource/ResourceLocator.hpp | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) (limited to 'src/core/resource/ResourceLocator.hpp') diff --git a/src/core/resource/ResourceLocator.hpp b/src/core/resource/ResourceLocator.hpp index d6a2ffc..d8afcb2 100644 --- a/src/core/resource/ResourceLocator.hpp +++ b/src/core/resource/ResourceLocator.hpp @@ -71,7 +71,8 @@ protected: * the resource is looked up. * @param relativeTo is an already resolved Resource relative to which the * file should be searched. - * @return a list of matching, autocompleted file paths. + * @return a list of matching, autocompleted file paths. If autocomplete is + * not supported, simply returns the given path as a result. */ virtual std::vector doAutocomplete( const std::string &path, const ResourceType type, @@ -108,7 +109,8 @@ public: * the resource is looked up. * @param relativeTo is an already resolved Resource relative to which the * file should be searched. - * @return a list of matching, autocompleted file paths. + * @return a list of matching, autocompleted file paths. If autocomplete is + * not supported, simply returns the given path as a result. */ std::vector autocomplete( const std::string &path, @@ -126,7 +128,8 @@ public: * the resource is looked up. * @param relativeTo is the location of an already resolved resource * relative to which this resource should be located. - * @return a list of matching, autocompleted file paths. + * @return a list of matching, autocompleted file paths. If autocomplete is + * not supported, simply returns the given path as a result. */ std::vector autocomplete(const std::string &path, const ResourceType type, -- cgit v1.2.3