Add documentation for VirtualFileSystem::get_target

[builder.git] / source / virtualfilesystem.h

diff --git a/source/virtualfilesystem.h b/source/virtualfilesystem.h
index f0cb7383fc9e26ea093d558cbb5bc2885d574f89..aef6ab09392a6cafc83a1f68d58abb295a6f709b 100644 (file)
--- a/source/virtualfilesystem.h
+++ b/source/virtualfilesystem.h
@@ -17,10 +17,10 @@ possible to build them.
 class VirtualFileSystem
 {
 public:
-       typedef std::list<std::string> SearchPath;
+       typedef std::list<Msp::FS::Path> SearchPath;
 
 private:
-       typedef std::map<std::string, FileTarget *> TargetMap;
+       typedef std::map<Msp::FS::Path, FileTarget *> TargetMap;
 
        Builder &builder;
        TargetMap targets;
@@ -29,6 +29,8 @@ private:
 public:
        VirtualFileSystem(Builder &);
 
+       /** Gets an existing target associated with a path.  If no target has claimed
+       that path, 0 is returned. */
        FileTarget *get_target(const Msp::FS::Path &) const;
 
        /** Registers a target with the VFS.  A target may be registered at multiple