Fix documentation to use @returns instead of @retval

RESOLVED WONTFIX

Status

()

--
trivial
RESOLVED WONTFIX
12 years ago
4 years ago

People

(Reporter: sciguyryan, Unassigned)

Tracking

Trunk
mozilla1.9alpha1
Points:
---

Firefox Tracking Flags

(Not tracked)

Details

Attachments

(3 attachments)

(Reporter)

Description

12 years ago
As with bug #363902 there are a few other instances of .idl files using @retval instead of @returns.
(Reporter)

Updated

12 years ago
Severity: normal → trivial
(Reporter)

Updated

12 years ago
Summary: Fix documentation to use @returns, not @retval → Fix documentation to use @returns instead of @retval
(Reporter)

Comment 1

12 years ago
Created attachment 252517 [details] [diff] [review]
Patch for netwerk V1

Patch v1 for netwerk

The following files have been changed:
* netwerk/base/public/nsReadLine.h
* netwerk/base/public/nsIAuthPrompt2.idl
Attachment #252517 - Flags: review?(cbiesinger)
(Reporter)

Comment 2

12 years ago
Created attachment 252518 [details] [diff] [review]
Patch for XPCOM V1

Patch v1 for XPCOM

The following files have been changed:
* xpcom/io/nsIUnicharOutputStream.idl
* xpcom/io/nsIUnicharLineInputStream.idl
Attachment #252518 - Flags: review?(benjamin)
(Reporter)

Comment 3

12 years ago
Created attachment 252519 [details] [diff] [review]
Patch for parser v1

Patch v1 for parser

The following files have been changed:
* parser/htmlparser/public/nsIExpatSink.idl
Attachment #252519 - Flags: review?(jst)
Comment on attachment 252517 [details] [diff] [review]
Patch for netwerk V1

retval and returns are not equivalent. see http://www.stack.nl/~dimitri/doxygen/commands.html#cmdretval
Attachment #252517 - Flags: review?(cbiesinger) → review-
(Reporter)

Updated

12 years ago
Attachment #252518 - Flags: review?(benjamin)
(Reporter)

Updated

12 years ago
Attachment #252519 - Flags: review?(jst)
(Reporter)

Comment 5

12 years ago
I've cancelled the requests for review based on Christian's comment comment #4.
(Reporter)

Updated

12 years ago
Assignee: sciguyryan → nobody
Status: ASSIGNED → NEW
(Reporter)

Comment 6

4 years ago
As per bug 363902.
Status: NEW → RESOLVED
Last Resolved: 4 years ago
Resolution: --- → WONTFIX
You need to log in before you can comment on or make changes to this bug.