Closed Bug 367926 Opened 18 years ago Closed 10 years ago

Fix documentation to use @returns instead of @retval

Categories

(Core :: General, defect)

Product:
Core
Component:
General
Type:
defect
Priority:
Not set
Severity:
trivial

Tracking

()

Status:
RESOLVED WONTFIX
Milestone:
mozilla1.9alpha1

People

(Reporter: sciguyryan, Unassigned)

References

Details

Attachments

(3 files)

Patch for netwerk V1
3.41 KB, patch
Biesinger
: review-
Details | Diff | Splinter Review
Patch for XPCOM V1
2.83 KB, patch
Details | Diff | Splinter Review
Patch for parser v1
1.04 KB, patch
Details | Diff | Splinter Review 
As with bug #363902 there are a few other instances of .idl files using @retval instead of @returns.
Severity: normal → trivial
Summary: Fix documentation to use @returns, not @retval → Fix documentation to use @returns instead of @retval
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)
Patch v1 for XPCOM

The following files have been changed:
* xpcom/io/nsIUnicharOutputStream.idl
* xpcom/io/nsIUnicharLineInputStream.idl
Attachment #252518 - Flags: review?(benjamin)
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-
Attachment #252518 - Flags: review?(benjamin)
Attachment #252519 - Flags: review?(jst)
I've cancelled the requests for review based on Christian's comment comment #4.
Assignee: sciguyryan → nobody
Status: ASSIGNED → NEW
As per bug 363902.
Status: NEW → RESOLVED
Closed: 10 years ago
Resolution: --- → WONTFIX
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Creator:
Created:
Updated:
Size: