Issue 116 - Document the libadblockplus API

include/AdblockPlus/DefaultWebRequest.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_DEFAULT_WEB_REQUEST_H
 #define ADBLOCK_PLUS_DEFAULT_WEB_REQUEST_H
 
 #include "WebRequest.h"
 
 namespace AdblockPlus
 {
   /**
    * `WebRequest` implementation that uses `WinInet` on Windows and libcurl
-   * on other systems. A dummy implementation is used if libcurl is not

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

"other platforms"?

Also, "A dummy implementation always reporting failure"?

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

Done.

-   * available.
+   * on other platforms. A dummy implementation that always reports failure is
+   * used if libcurl is not available.
    */
   class DefaultWebRequest : public WebRequest
   {
     ServerResponse GET(const std::string& url, const HeaderList& requestHeaders) const;
   };
 }
 
 #endif