220477 - convert nsIURILoader comments to doxygen-style comments

Status: RESOLVED FIXED

(Core Graveyard :: File Handling, defect)

Description

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

Comment 1

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

Attachment: patch

Comment 2

[Boris Zbarsky [:bzbarsky]]

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

r=me.  we should look into actually cleaning up and freezing this interface,
btw...

Comment 3

[Darin Fisher]

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

>Index: base/nsIURILoader.idl

>+  /**
>+   * OpenURI requires the following parameters.....
>+   * @param aChannel The channel that should be opened. This must not be
>+   *                 asyncOpen'd yet!
>+   * @param aIsContentPreferred Should the content be displayed in a container that prefers
>+   *                            the content-type, or will any container do.
>+   * @param aWindowContext if you are running the url from a doc shell or a
>+   *                       web shell, this is your window context. If you have a
>+   *                       content listener you want to give first crack to, the
>+   *                       uri loader needs to be able to get it from the window
>+   *                       context (we'll use nsIInterfaceRequestor).  we will
>+   *                       also be using nsIInterfaceRequestor to get at the
>+   *                       progress event sink interface.
>+   */ 

  /**
   * OpenURI requires the following parameters.....
   * @param aChannel
   *	    The channel that should be opened. This must not be asyncOpen'd
yet!
   * @param aIsContentPreferred
   *	    Should the content be displayed in a container that prefers the
   *	    content-type, or will any container do.
   * @param aWindowContext
   *	    If you are running the url from a doc shell or a web shell, this is
   *	    your window context. If you have a content listener you want to
give
   *	    first crack to, the uri loader needs to be able to get it from the
   *	    window context (we'll use nsIInterfaceRequestor).  we will also be
   *	    using nsIInterfaceRequestor to get at the progress event sink
   *	    interface.
   */ 

nit: i think this style of documenting parameters works better, but you can of
course pick whatever style you prefer.

sr=darin

Comment 4

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

hm, yeah, your style does indeed look better. checked in with that change

Checking in nsIURILoader.idl;
/cvsroot/mozilla/uriloader/base/nsIURILoader.idl,v  <--  nsIURILoader.idl
new revision: 1.27; previous revision: 1.26
done