If you think a bug might affect users in the 57 release, please set the correct tracking and status flags for Release Management.

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

RESOLVED INCOMPLETE

Status

()

Core
Networking
--
enhancement
RESOLVED INCOMPLETE
12 years ago
2 years ago

People

(Reporter: timeless, Assigned: db48x)

Tracking

Trunk
x86
Windows XP
Points:
---

Firefox Tracking Flags

(Not tracked)

Details

(URL)

Attachments

(1 attachment)

(Reporter)

Description

12 years ago
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.
(Assignee)

Comment 1

12 years ago
Created attachment 216179 [details] [diff] [review]
331564-1.diff
Assignee: nobody → db48x
Status: NEW → ASSIGNED
(Assignee)

Updated

12 years ago
Attachment #216179 - Flags: review?(timeless)

Comment 2

12 years ago
why is throws better than throw?
(Assignee)

Comment 3

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

Comment 4

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

That lists "throw" and "throws" as synonyms.
(Assignee)

Comment 5

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

Comment 6

12 years ago
OK, and is javadoc actually used to generate documention from IDL?  I thought we were targeting doxygen, no?
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.
(Assignee)

Comment 8

12 years ago
Yea, most of the files use @throws
(Reporter)

Updated

12 years ago
Attachment #216179 - Flags: review?(timeless) → review+
Status: ASSIGNED → RESOLVED
Last Resolved: 2 years ago
Resolution: --- → INCOMPLETE
You need to log in before you can comment on or make changes to this bug.