IDL interfaces in intl should include some documentation

RESOLVED FIXED in mozilla1.9.2a1

Status

()

Core
Internationalization
--
minor
RESOLVED FIXED
10 years ago
9 years ago

People

(Reporter: Jesper Kristensen, Assigned: Jesper Kristensen)

Tracking

Trunk
mozilla1.9.2a1
Points:
---
Bug Flags:
in-testsuite -

Firefox Tracking Flags

(Not tracked)

Details

Attachments

(1 attachment, 2 obsolete attachments)

(Assignee)

Description

10 years ago
User-Agent:       Mozilla/5.0 (Windows; U; Windows NT 6.0; da; rv:1.9.0.5) Gecko/2008120122 Firefox/3.0.5 Ubiquity/0.1.4
Build Identifier: 

Many IDL files in mozilla has documentation in them, but the files in http://mxr.mozilla.org/mozilla-central/source/intl/locale/idl/ have little or none.

What does "application default" mean in nsIScriptableDateFormat? I assumed it to mean the language of the application user interface, but that is not what it currently does, and there is debate on what it should do (bug 441167).

Also nsILocaleService is quite confusing. I had a guess on what getApplicationLocale and getLocaleComponentForUserAgent does by looking at their names, but when I looked at the code, that was not anything near what they actually did. Telling what they actually do in the idl file would be nice.

I will be happy to write the documentation, if I am told that it is wanted.

Reproducible: Always

Updated

10 years ago
Blocks: 181515
(In reply to comment #0)
 
> I will be happy to write the documentation, if I am told that it is wanted.

That would be very useful, thank you!
Assignee: smontagu → bugzilla
Status: UNCONFIRMED → NEW
Ever confirmed: true
(Assignee)

Comment 2

9 years ago
Created attachment 360567 [details] [diff] [review]
patch
(Assignee)

Comment 3

9 years ago
Created attachment 363661 [details] [diff] [review]
patch2
Attachment #360567 - Attachment is obsolete: true
Attachment #363661 - Flags: review?(smontagu)
Comment on attachment 363661 [details] [diff] [review]
patch2

>+     * Pass a locale code as described in nsILocale as the locale parameter
>+     * (e.g. en-US) to use a specific locale (This fails on Mac OS, see bug
>+     * 472960 and bug 22310). If the given locale is not available, a fallback
>+     * will be used.

You can cut out the sentence about failing on Mac OS now :)
Attachment #363661 - Flags: review?(smontagu) → review+
(Assignee)

Comment 5

9 years ago
Created attachment 367610 [details] [diff] [review]
patch2 with Mac OS note removed
[Checkin: Comment 6]
Attachment #363661 - Attachment is obsolete: true
(Assignee)

Updated

9 years ago
Keywords: checkin-needed
Comment on attachment 367610 [details] [diff] [review]
patch2 with Mac OS note removed
[Checkin: Comment 6]


http://hg.mozilla.org/mozilla-central/rev/725b47d5d4ec
Attachment #367610 - Attachment description: patch2 with Mac OS note removed → patch2 with Mac OS note removed [Checkin: Comment 6]
Status: NEW → RESOLVED
Last Resolved: 9 years ago
Flags: in-testsuite-
Keywords: checkin-needed
Resolution: --- → FIXED
Target Milestone: --- → mozilla1.9.2a1
Version: unspecified → Trunk
Keywords: dev-doc-needed
Keywords: dev-doc-needed
You need to log in before you can comment on or make changes to this bug.