diff options
| author | Andreas Stöckel <astoecke@techfak.uni-bielefeld.de> | 2015-02-17 01:05:32 +0100 |
|---|---|---|
| committer | Andreas Stöckel <astoecke@techfak.uni-bielefeld.de> | 2015-02-17 01:05:32 +0100 |
| commit | ca0081e14b96eb6436ad349be2f2148520c16f38 (patch) | |
| tree | 8b93e3a41637b5b124e4ad4570a51bb4519847e2 /src/core/resource/ResourceLocator.hpp | |
| parent | 8eb2bed0115b5f6884fe12ecda80974aa6c21761 (diff) | |
Improved semantics of the return value of the autocomplete function: Empty return value explicitly means that the file does not exist at all.
Diffstat (limited to 'src/core/resource/ResourceLocator.hpp')
| -rw-r--r-- | src/core/resource/ResourceLocator.hpp | 9 |
1 files changed, 6 insertions, 3 deletions
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<std::string> 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<std::string> 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<std::string> autocomplete(const std::string &path, const ResourceType type, |