Bug 1111017 - Followup on Bug 1087442 - Updating comments (r=sicking)

This commit is contained in:
Christoph Kerschbaumer 2014-12-12 13:45:51 -08:00
parent c3ba2c1217
commit 426d902f38
3 changed files with 19 additions and 21 deletions

View File

@ -67,10 +67,6 @@ interface nsIIOService : nsISupports
/**
* Creates a channel for a given URI.
*
* Please note, if you provide both a loadingNode and a loadingPrincipal,
* then loadingPrincipal must be equal to loadingNode->NodePrincipal().
* But less error prone is to just supply a loadingNode.
*
* @param aURI
* nsIURI from which to make a channel
* @param aLoadingNode
@ -122,6 +118,9 @@ interface nsIIOService : nsISupports
* Any of the content types defined in nsIContentPolicy.idl
* @return reference to the new nsIChannel object
*
* Please note, if you provide both a loadingNode and a loadingPrincipal,
* then loadingPrincipal must be equal to loadingNode->NodePrincipal().
* But less error prone is to just supply a loadingNode.
*/
nsIChannel newChannelFromURI2(in nsIURI aURI,
in nsIDOMNode aLoadingNode,

View File

@ -33,10 +33,6 @@ interface nsIIOService2 : nsIIOService
/**
* Creates a channel for a given URI.
*
* Please note, if you provide both a loadingNode and a loadingPrincipal,
* then loadingPrincipal must be equal to loadingNode->NodePrincipal().
* But less error prone is to just supply a loadingNode.
*
* @param aURI
* nsIURI from which to make a channel
* @param aProxyURI
@ -93,6 +89,9 @@ interface nsIIOService2 : nsIIOService
* Any of the content types defined in nsIContentPolicy.idl
* @return reference to the new nsIChannel object
*
* Please note, if you provide both a loadingNode and a loadingPrincipal,
* then loadingPrincipal must be equal to loadingNode->NodePrincipal().
* But less error prone is to just supply a loadingNode.
*/
nsIChannel newChannelFromURIWithProxyFlags2(in nsIURI aURI,
in nsIURI aProxyURI,

View File

@ -193,9 +193,16 @@ NS_NewFileURI(nsIURI* *result,
* NS_NewInputStreamChannel, NS_NewChannelInternal
* and it's variations:
*
* Please note, if you provide both a loadingNode and a loadingPrincipal,
* then loadingPrincipal must be equal to loadingNode->NodePrincipal().
* But less error prone is to just supply a loadingNode.
* What specific API function to use:
* * The NS_NewChannelInternal functions should almost never be directly
* called outside of necko code.
* * If possible, use NS_NewChannel() providing a loading *nsINode*
* * If no loading *nsINode* is avaialable, call NS_NewChannel() providing
* a loading *nsIPrincipal*.
* * Call NS_NewChannelWithTriggeringPrincipal if the triggeringPrincipal
* is different from the loadingPrincipal.
* * Call NS_NewChannelInternal() providing aLoadInfo object in cases where
* you already have loadInfo object, e.g in case of a channel redirect.
*
* @param aURI
* nsIURI from which to make a channel
@ -247,16 +254,9 @@ NS_NewFileURI(nsIURI* *result,
* The contentPolicyType of the channel.
* Any of the content types defined in nsIContentPolicy.idl
*
* What specific API function to use:
* * The NS_NewChannelInternal functions should almost never be directly
* called outside of necko code.
* * If possible, use NS_NewChannel() providing a loading *nsINode*
* * If no loading *nsINode* is avaialable, call NS_NewChannel() providing
* a loading *nsIPrincipal*.
* * Call NS_NewChannelWithTriggeringPrincipal if the triggeringPrincipal
* is different from the loadingPrincipal.
* * Call NS_NewChannelInternal() providing aLoadInfo object in cases where
* you already have loadInfo object, e.g in case of a channel redirect.
* Please note, if you provide both a loadingNode and a loadingPrincipal,
* then loadingPrincipal must be equal to loadingNode->NodePrincipal().
* But less error prone is to just supply a loadingNode.
*/
inline nsresult
NS_NewChannelInternal(nsIChannel** outChannel,