Issue 116 - Document the libadblockplus API

include/AdblockPlus/DefaultFileSystem.h

 /*
  * This file is part of Adblock Plus <http://adblockplus.org/>,
  * Copyright (C) 2006-2014 Eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ skipping 12 matching lines @@
 #ifdef _WIN32
 #define PATH_SEPARATOR '\\'
 #else
 #define PATH_SEPARATOR '/'
 #endif
 
 namespace AdblockPlus
 {
   /**
    * `FileSystem` implementation that interacts directly with the operating
    * system's file system.

[Wladimir Palant, 2014/08/29 18:42:27]

"All paths are considered relative to the base path or to the current work
directory if no base path is set."

[Felix Dahlke, 2014/09/01 17:00:15]

Done.

+   * All paths are considered relative to the base path, or to the current
+   * working directory if no base path is set (see `SetBasePath()`).
    */
   class DefaultFileSystem : public FileSystem
   {
   public:
     std::tr1::shared_ptr<std::istream> Read(const std::string& path) const;
     void Write(const std::string& path,
                std::tr1::shared_ptr<std::istream> data);
     void Move(const std::string& fromPath,
                       const std::string& toPath);
     void Remove(const std::string& path);
     StatResult Stat(const std::string& path) const;
     std::string Resolve(const std::string& path) const;
+
+    /**
+     * Sets the base path, all paths are considered relative to it.
+     * @param path Base path.
+     */
     void SetBasePath(const std::string& path);

[Wladimir Palant, 2014/08/29 18:42:27]

This method needs documenting, it isn't part of the interface.

[Felix Dahlke, 2014/09/01 17:00:15]

Done.

+
   protected:
     std::string basePath;
   };
 }
 
 #endif