Issue 116 - Document the libadblockplus API

include/AdblockPlus/FilterEngine.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 53 matching lines @@
 
     /**
      * Removes this filter from the list of custom filters.
      */
     void RemoveFromList();
 
     bool operator==(const Filter& filter) const;
 
     /**
      * Creates a wrapper for an existing JavaScript filter object.
-     * Normally you shouldn't call this directly, but use GetFilter() instead.

[Wladimir Palant, 2014/09/01 17:36:56]

It's FilterEngine::GetFilter(), not Filter::GetFilter().

[Felix Dahlke, 2014/09/02 05:24:51]

Done.

+     * Normally you shouldn't call this directly, but use
+     * FilterEngine::GetFilter() instead.
      * @param value JavaScript filter object.
      */
     Filter(JsValuePtr value);
   };
 
   /**
    * Wrapper for a subscription object.
    */
   class Subscription : public JsValue,
                        public std::tr1::enable_shared_from_this<Subscription>
@@ skipping 15 matching lines @@
      */
     void RemoveFromList();
 
     /**
      * Updates this subscription, i.e.\ retrieves the current filters from the
      * subscription URL.
      */
     void UpdateFilters();
 
     /**
-     * Checks if this subscriptions is currently being updated.
-     * @return `true` if this subscriptions is currently being updated.
+     * Checks if the subscription is currently being updated.
+     * @return `true` if the subscription is currently being updated.
      */
     bool IsUpdating();
 
     bool operator==(const Subscription& subscription) const;
 
     /**
      * Creates a wrapper for an existing JavaScript subscription object.
-     * Normally you shouldn't call this directly, but use GetSubscription()

[Wladimir Palant, 2014/09/01 17:36:56]

It's FilterEngine::GetSubscription(), not Subscription::GetSubscription().

[Felix Dahlke, 2014/09/02 05:24:51]

Done.

-     * instead.
+     * Normally you shouldn't call this directly, but use
+     * FilterEngine::GetSubscription() instead.
      * @param value JavaScript subscription object.
      */
     Subscription(JsValuePtr value);
   };
 
   /**
    * Shared smart pointer to a `Filter` instance.
    */
   typedef std::tr1::shared_ptr<Filter> FilterPtr;
 
   /**
    * Shared smart pointer to a `Subscription` instance.
    */
   typedef std::tr1::shared_ptr<Subscription> SubscriptionPtr;
 
   /**
-   * Main component of Libadblockplus.
+   * Main component of libadblockplus.
    * It handles:
    * - Filter management and matching.
    * - Subscription management and synchronization.
    * - Update checks for the application.
    */
   class FilterEngine
   {
   public:
     /**
      * Callback type invoked when an update is available.
@@ skipping 191 matching lines @@
     void InitDone(JsValueList& params);
     FilterPtr CheckFilterMatch(const std::string& url,
                                const std::string& contentType,
                                const std::string& documentUrl) const;
     void UpdateCheckDone(const std::string& eventName, UpdaterCallback callback, JsValueList& params);
     void FilterChanged(FilterChangeCallback callback, JsValueList& params);
   };
 }
 
 #endif