261352 - document (comment) nsIDocumentLoader.idl

Status: RESOLVED FIXED

(Core Graveyard :: File Handling, defect)

Description

[fantasai]

definitions in nsIDocumentLoader.idl are undocumented

Comment 1

[fantasai]

Attachment: patch

Attaching patch written by Daniel O'Connor

I can't review this, but whoever looks at it should note the removal of two
lines of comment.

Comment 2

[Christian :Biesinger (don't email me, ping me on IRC)]

this conflicts with bug 234257 :/

and this interface is expected to go away

Comment 3

[Christian :Biesinger (don't email me, ping me on IRC)]

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

+ * @todo Documentation: Assign a status (Frozen?)

this interface will NOT be frozen anytime soon


+ * nsIDocumentLoader is an interface for handling the document loading
process.

this is misleading. this comment would fit better with nsIURILoader.

Comment 4

[Boris Zbarsky [:bzbarsky]]

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

biesi's right.	This patch needs to be synced to the changes in bug 234257 at
the very least.  Also, the documentation for stop(), getLoadGroup(),
getContentViewerContainer(), createDocumentLoader(), while true, doesn't say
any more than the method names do.  For example, what does stop() actually
stop()?

Finally, there are no child event listeners involved (in particular, there are
no child listeners, and no event listeners; there are some
nsIWebProgressListeners around, though), so the documentation for
fireOnStatusChange() and fireOnLocationChange() is wrong.

Frankly, if we do plan to remove this interface (which I think we do),
documenting it is not really worth the time..

Comment 5

[Christian :Biesinger (don't email me, ping me on IRC)]

fixed by bug 273319. the comments don't use doxygen style, but I don't think
that's much of an issue, as we want to kill this interface. please reopen if you
disagree.

changing URI to point to trunk version of the file