Issue 116 - Document the libadblockplus API

include/AdblockPlus/ReferrerMapping.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
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 #ifndef ADBLOCK_PLUS_REFERRER_MAPPING_H
 #define ADBLOCK_PLUS_REFERRER_MAPPING_H
 
 #include <list>
 #include <map>
 #include <string>
 #include <vector>
 
 namespace AdblockPlus
 {
+  /**
+   * Stores a mapping between URLs and their referrers.
+   * This can be used to build a chain of referrers for any URL
+   * (see `BuildReferrerChain()`), which approximates the frame structure.
+   */
   class ReferrerMapping
   {
   public:
+    /**
+     * Constructor.
+     * @param maxCachedUrls Number of URL mappings to store. The higher the
+     *        better - clients typically cache requests, and a single cached
+     *        request will break the referrer chain.
+     */
     ReferrerMapping(const int maxCachedUrls = 5000);
+
+    /**
+     * Adds a new mapping from URL to referrer.

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

"Records the referrer for a URL"?

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

Done.

+     * @param url Request URL.
+     * @param referrer Request referrer.
+     */
     void Add(const std::string& url, const std::string& referrer);
+
+    /**
+     * Builds the referrer chain for the supplied URL.

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

"Reconstructs the URLs of parent frames for a document URL"?

+     * @param url URL to build the chain for.
+     * @return List of URLs, starting with `url`.
+     */
     std::vector<std::string> BuildReferrerChain(const std::string& url) const;
 
   private:
     const int maxCachedUrls;
     std::map<std::string, std::string> mapping;
     std::list<std::string> cachedUrls;
   };
 }
 
 #endif