Bug 1220610 - Fix the nsIDocument::GetDocumentURI and nsIDocument::GetOriginalURI comments to be correct and up to date. r=baku
authorJonathan Watt <jwatt@jwatt.org>
Thu, 01 Oct 2015 10:12:36 +0100
changeset 270788 78cbe4c1c2a1fd0703bd2e8c5a3fcf1e35e7bb71
parent 270787 ffe32a4ed0a0b21d021fbdd2df1abb17e8d50f66
child 270789 0f6c7cb9fd50a36d8ae0918b9e01f7c578f70718
push id67462
push userjwatt@jwatt.org
push dateMon, 02 Nov 2015 19:11:09 +0000
treeherdermozilla-inbound@78cbe4c1c2a1 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersbaku
bugs1220610
milestone45.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1220610 - Fix the nsIDocument::GetDocumentURI and nsIDocument::GetOriginalURI comments to be correct and up to date. r=baku
dom/base/nsIDocument.h
--- a/dom/base/nsIDocument.h
+++ b/dom/base/nsIDocument.h
@@ -245,32 +245,38 @@ public:
    * @param aBoundTitleElement true if an HTML or SVG <title> element
    * has just been bound to the document.
    */
   virtual void NotifyPossibleTitleChange(bool aBoundTitleElement) = 0;
 
   /**
    * Return the URI for the document. May return null.
    *
-   * The value returned corresponds to the "document's current address" in
+   * The value returned corresponds to the "document's address" in
    * HTML5.  As such, it may change over the lifetime of the document, for
-   * instance as a result of a call to pushState() or replaceState().
+   * instance as a result of the user navigating to a fragment identifier on
+   * the page, or as a result to a call to pushState() or replaceState().
+   *
+   * https://html.spec.whatwg.org/multipage/dom.html#the-document%27s-address
    */
   nsIURI* GetDocumentURI() const
   {
     return mDocumentURI;
   }
 
   /**
    * Return the original URI of the document.  This is the same as the
-   * document's URI unless history.pushState() or replaceState() is invoked on
-   * the document.
+   * document's URI unless that has changed from its original value (for
+   * example, due to history.pushState() or replaceState() being invoked on the
+   * document).
    *
-   * This method corresponds to the "document's address" in HTML5 and, once
-   * set, doesn't change over the lifetime of the document.
+   * This method corresponds to the "creation URL" in HTML5 and, once set,
+   * doesn't change over the lifetime of the document.
+   *
+   * https://html.spec.whatwg.org/multipage/webappapis.html#creation-url
    */
   nsIURI* GetOriginalURI() const
   {
     return mOriginalURI;
   }
 
   /**
    * Set the URI for the document.  This also sets the document's original URI,