331564 - please change idl interfaces to use @throws instead of @throw

Status: RESOLVED INCOMPLETE

(Core :: Networking, enhancement)

Description

[timeless]

steps to reproduce: visit mxr-test/seamonkey/search

Search for:   @throw
 
 Regular Expression Search  
Find files matching:  idl$
Limit output to pattern:  throw[^s]



--------------------------------------------------------------------------------

These files were searched.

Found 25 matching lines

@throw
/toolkit/components/commandlines/public/nsICommandLineHandler.idl, line 75 -- * @throw NS_ERROR_ABORT to immediately cease command-line handling
/toolkit/xre/nsIXULRuntime.idl, line 80 -- * @throw NS_ERROR_NOT_AVAILABLE if not available.
/netwerk/mime/public/nsIMIMEInfo.idl, line 154 -- * @throw NS_ERROR_INVALID_ARG if action is not valid for this function.
/netwerk/protocol/http/public/nsIHttpHeaderVisitor.idl, line 58 -- * @throw any exception to terminate enumeration
/netwerk/protocol/file/public/nsIFileProtocolHandler.idl, line 76 -- * @throw NS_ERROR_NOT_AVAILABLE if the OS does not support such files.
/netwerk/protocol/file/public/nsIFileProtocolHandler.idl, line 77 -- * @throw NS_ERROR_NOT_AVAILABLE if this file is not an internet shortcut.
/netwerk/base/public/nsIResumableChannel.idl, line 67 -- * @throw NS_ERROR_NOT_RESUMABLE if this load is not resumable.
/netwerk/base/public/nsIContentSniffer.idl, line 58 -- * @throw NS_ERROR_NOT_AVAILABLE if no MIME type could be determined.
/netwerk/base/public/nsIProtocolProxyService.idl, line 176 -- * @throw NS_ERROR_NOT_AVAILABLE if there is no alternate proxy available.
/netwerk/base/public/nsIChannelEventSink.idl, line 97 -- * @throw <any> Throwing an exception will cancel the load. No network
/uriloader/exthandler/nsIExternalProtocolService.idl, line 97 -- * @throw NS_ERROR_NOT_IMPLEMENTED
/uriloader/exthandler/nsIExternalProtocolService.idl, line 99 -- * @throw NS_ERROR_NOT_AVAILABLE
/uriloader/base/nsIWebProgress.idl, line 138 -- * @throw NS_ERROR_INVALID_ARG
/uriloader/base/nsIWebProgress.idl, line 141 -- * @throw NS_ERROR_FAILURE
/uriloader/base/nsIWebProgress.idl, line 154 -- * @throw NS_ERROR_FAILURE
/uriloader/base/nsIWebProgress.idl, line 162 -- * @throw NS_ERROR_FAILURE
/uriloader/base/nsIContentHandler.idl, line 60 -- * @throw NS_ERROR_WONT_HANDLE_CONTENT Indicates that this handler does not
/docshell/base/nsIWebNavigation.idl, line 76 -- * @throw NS_ERROR_UNEXPECTED
/docshell/base/nsIWebNavigation.idl, line 88 -- * @throw NS_ERROR_UNEXPECTED
/docshell/base/nsIWebNavigation.idl, line 97 -- * @throw NS_ERROR_UNEXPECTED
/docshell/base/nsIWebNavigation.idl, line 227 -- * @throw NS_BINDING_ABORTED
/embedding/browser/webBrowser/nsIWebBrowserStream.idl, line 66 -- * @throw NS_ERROR_NOT_AVAILABLE
/embedding/browser/webBrowser/nsIWebBrowserStream.idl, line 68 -- * @throw NS_ERROR_IN_PROGRESS
/embedding/browser/webBrowser/nsIWebBrowserStream.idl, line 87 -- * @throw NS_ERROR_UNEXPECTED
/intl/uconv/idl/nsIScriptableUConv.idl, line 100 -- * @throw NS_ERROR_UCONV_NOCONV

This page was automatically generated by MXR-test.

Comment 1

[Daniel Brooks [:db48x]]

Attachment: 331564-1.diff

Comment 2

[Darin Fisher]

why is throws better than throw?

Comment 3

[Daniel Brooks [:db48x]]

because a javadoc processor is going to be looking for @throws

Comment 4

[Darin Fisher]

http://www.stack.nl/~dimitri/doxygen/commands.html#cmdthrow ?

That lists "throw" and "throws" as synonyms.

Comment 5

[Daniel Brooks [:db48x]]

http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html#@throws only lists @throws and @exceptions.

Comment 6

[Darin Fisher]

OK, and is javadoc actually used to generate documention from IDL?  I thought we were targeting doxygen, no?

Comment 7

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

I didn't think javadoc could extract documentation from C++ files.

When I asked timeless about the reason for this bug I was told it was for easier searching.

Comment 8

[Daniel Brooks [:db48x]]

Yea, most of the files use @throws