Issue 116 - Document the libadblockplus API

include/AdblockPlus/WebRequest.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 20 matching lines @@
    */
   typedef std::vector<std::pair<std::string, std::string> > HeaderList;
 
   /**
    * HTTP response.
    */
   struct ServerResponse
   {
     //@{
     /**
-     * Status code of the response.

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

[Mozilla status
code](https://developer.mozilla.org/en/docs/Table_Of_Errors#Network_Errors)
indicating the network-level request status. This should be 0 (NS_OK) if the
request succeeded. Note that this should be NS_OK if the server responded with
an error code like "404 Not Found".

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

Done.

+     * [Mozilla status code](https://developer.mozilla.org/en/docs/Table_Of_Errors#Network_Errors)
+     * indicating the network-level request status.
+     * This should be 0 (NS_OK) if the request succeeded. Note that this should
+     * be NS_OK if the server responded with an error code like "404 Not Found".
      */
 #ifdef _WIN32
     __int64 status;
 #else
     int64_t status;
 #endif
     //@}
 
     /**
      * List of response headers.
      */
     HeaderList responseHeaders;
 
     /**
-     * HTTP status of the response.

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

" like 200 or 404"?

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

Done.

+     * HTTP status of the response (e.g.\ 404).
      */
     int responseStatus;
 
     /**
      * Body text of the response.
      */
     std::string responseText;
   };
 
   /**
    * Web request interface.
    */
   class WebRequest
   {
   public:
     /**
-     * Possible response status codes.
+     * Possible [Mozilla status codes](https://developer.mozilla.org/en/docs/Table_Of_Errors#Network_Errors).
      */
     enum
     {
       NS_OK = 0,
       NS_ERROR_FAILURE = 0x80004005,
       NS_ERROR_OUT_OF_MEMORY = 0x8007000e,
       NS_ERROR_MALFORMED_URI = 0x804b000a,
       NS_ERROR_CONNECTION_REFUSED = 0x804b000d,
       NS_ERROR_NET_TIMEOUT = 0x804b000e,
       NS_ERROR_NO_CONTENT = 0x804b0011,
@@ skipping 19 matching lines @@
     virtual ServerResponse GET(const std::string& url, const HeaderList& requestHeaders) const = 0;
   };
 
   /**
    * Shared smart pointer to a `WebRequest` instance.
    */
   typedef std::tr1::shared_ptr<WebRequest> WebRequestPtr;
 }
 
 #endif