Bug 1442429 - Correct the documentation for nsIBrowserSearchService::addEngineWithDetails r=mkaply
authorKirk Steuber <ksteuber@mozilla.com>
Thu, 01 Mar 2018 14:13:51 -0800
changeset 762421 cfc5d19e856fc43766669069b7e2695dd519e5c3
parent 762420 114d99e1c41c8bf49633d331cf3edbe236c2b4a5
child 762422 6f54af02c2e61f623bfa847074b4c640e73c75a3
push id101169
push userluca.greco@alcacoop.it
push dateFri, 02 Mar 2018 12:32:00 +0000
reviewersmkaply
bugs1442429
milestone60.0a1
Bug 1442429 - Correct the documentation for nsIBrowserSearchService::addEngineWithDetails r=mkaply MozReview-Commit-ID: EryCTRT5t5I
netwerk/base/nsIBrowserSearchService.idl
--- a/netwerk/base/nsIBrowserSearchService.idl
+++ b/netwerk/base/nsIBrowserSearchService.idl
@@ -344,18 +344,20 @@ interface nsIBrowserSearchService : nsIS
    * @param description
    *        Optional: a description of the search engine.
    *
    * @param method
    *        Optional: The HTTP request method used when submitting a search query.
    *        Case insensitive value of either "get" or "post".
    *        Defaults to "get".
    *
-   * @param url
-   *        The URL to which search queries should be sent.
+   * @param template
+   *        The template for the URL to which search queries should be sent. The
+   *        template will be subjected to OpenSearch parameter substitution.
+   *        See http://www.opensearch.org/Specifications/OpenSearch
    *        Must not be null.
    *
    * @param extensionID [optional]
    *        Optional: The correct extensionID if called by an add-on.
    *
    * Alternatively, all of these parameters except for name can be
    * passed as an object in place of parameter two.
    *