Documentation error: Missing infoFlag from the list of Flag constants in a documentation about Error Console.

RESOLVED FIXED

Status

()

Core
XPCOM
--
trivial
RESOLVED FIXED
3 years ago
3 years ago

People

(Reporter: ISHIKAWA, Chiaki, Unassigned)

Tracking

Firefox Tracking Flags

(Not tracked)

Details

(Reporter)

Description

3 years ago
Missing infoFlag from the list of Flag constants in a documentation about Error Console.

There is a documentation 
https://developer.mozilla.org/en-US/docs/Mozilla/Tech/XPCOM/Reference/Interface/nsIScriptError

The above URL describes the error Console service.

In the page, there is a list of Flag constants.

https://developer.mozilla.org/en-US/docs/Mozilla/Tech/XPCOM/Reference/Interface/nsIScriptError#Flag_constants

--- begin quote ---
Constant 	Value 	Description
errorFlag 	0x0 	Error messages. A pseudo-flag for the default, error case.
warningFlag 	0x1 	Warning messages.
exceptionFlag 	0x2 	An exception was thrown for this case - exception-aware hosts can ignore this.
strictFlag 	0x4 	One of the flags declared in nsIScriptError.--
--- end quote ---

However, one wonders why there is no mention of "Information"
message. A message can be not a warning, not an error message,
and  just informational.

When you look at Error console of thunderbird, there are
clearly classes of messages:
 - Error message,
 - Warning Message, and
 - Information message.

One is forced to look for more info using source tree:
Eventually one finds
http://mxr.mozilla.org/comm-central/source/mozilla/js/xpconnect/idl/nsIScriptError.idl#15
--- begin quote

15 interface nsIScriptError : nsIConsoleMessage
16 {
17     /** pseudo-flag for default case */
18     const unsigned long errorFlag = 0x0;
19 
20     /** message is warning */
21     const unsigned long warningFlag = 0x1;
22 
23     /** exception was thrown for this case - exception-aware hosts can ignore */
24     const unsigned long exceptionFlag = 0x2;
25 
26     // XXX check how strict is implemented these days.
27     /** error or warning is due to strict option */
28     const unsigned long strictFlag = 0x4;
29 
30     /** just a log message */
31     const unsigned long infoFlag = 0x8;
32 
--- end quote

On line 31 above, we see "infoFlag = 0x8".

So please add to the table of Flag Constants in
https://developer.mozilla.org/en-US/docs/Mozilla/Tech/XPCOM/Reference/Interface/nsIScriptError#Flag_constants

the following line at the end!

infoFlag 	0x8 	Information messages.

TIA
(Reporter)

Updated

3 years ago
Flags: needinfo?(axelg)
(Reporter)

Comment 1

3 years ago
Axel Grude was the last person who modified the page.

Comment 2

3 years ago
Feel free to fix this, developer.mozilla.org is a wiki after all. We typically don't track that in bugzilla, though.
Status: NEW → RESOLVED
Last Resolved: 3 years ago
Resolution: --- → INCOMPLETE
I added the flag to the page. Next time just contact me directly or do the edit yourself. Most of the XPCOM interface pages were created by automatic tools so they are bound to have errors in them, when in doubt mxr / doxygen are right and can be used for corrections.
Flags: needinfo?(axelg)
Resolution: INCOMPLETE → FIXED
(Reporter)

Comment 4

3 years ago
(In reply to Axel Grude [:realRaven] from comment #3)
> I added the flag to the page. Next time just contact me directly or do the
> edit yourself. Most of the XPCOM interface pages were created by automatic
> tools so they are bound to have errors in them, when in doubt mxr / doxygen
> are right and can be used for corrections.

Thank you and will do the next time.
(I simply don't know the protocol for getting these documentation errors fixed.)
You need to log in before you can comment on or make changes to this bug.