1220610 - Fix the nsIDocument::GetDocumentURI and nsIDocument::GetOriginalURI comments to be correct and up to date

Status: RESOLVED FIXED

(Core :: DOM: Core & HTML, defect)

Description

[Jonathan Watt [:jwatt]]

Right now the comment for nsIDocument::GetOriginalURI says it returns what the spec calls the "document's address". This is exactly wrong, since the "document's address" changes with fragment identifier navigation and pushState changes, which is exactly what GetOriginalURI does *not* do. The comment for GetDocumentURI is also out of date.

Comment 1

[Jonathan Watt [:jwatt]]

Attachment: patch

Comment 2

[:Ms2ger (he/him; ⌚ UTC+1/+2)]

Comment on attachment 8681897 [details] [diff] [review]
patch

Review of attachment 8681897 [details] [diff] [review]:
-----------------------------------------------------------------

::: dom/base/nsIDocument.h
@@ +254,5 @@
>     * HTML5.  As such, it may change over the lifetime of the document, for
> +   * 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

Please use https://html.spec.whatwg.org/multipage/#foo, without the bar.html; that's a more stable URL.

Comment 3

[Pulsebot]

https://hg.mozilla.org/integration/mozilla-inbound/rev/78cbe4c1c2a1

Comment 4

[Carsten Book [:Tomcat]]

https://hg.mozilla.org/mozilla-central/rev/78cbe4c1c2a1

Comment 5

[Carsten Book [:Tomcat]]

https://hg.mozilla.org/releases/mozilla-b2g44_v2_5/rev/78cbe4c1c2a1

Comment 6

[Carsten Book [:Tomcat]]

removing the b2g 2.5 flag since this commit has been reverted due to an incorrect merge, sorry for the confusion