474636 - IDL interfaces in intl should include some documentation

Status: RESOLVED FIXED

(Core :: Internationalization, defect)

Description

[Jesper Kristensen]

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

Comment 1

[Simon Montagu :smontagu]

(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!

Comment 2

[Jesper Kristensen]

Attachment: patch

Comment 3

[Jesper Kristensen]

Attachment: patch2

Comment 4

[Simon Montagu :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 :)

Comment 5

[Jesper Kristensen]

Attachment: patch2 with Mac OS note removed [Checkin: Comment 6]

Comment 6

[Serge Gautherie (:sgautherie)]

Comment on attachment 367610 [details] [diff] [review]
patch2 with Mac OS note removed
[Checkin: Comment 6]


http://hg.mozilla.org/mozilla-central/rev/725b47d5d4ec