239434 - nsIPrefBranchInternal IDL Doc is wrong

Status: RESOLVED FIXED

(Core :: Preferences: Backend, defect)

Description

[timeless]

60    * will receive the notification via their |Observe| method. The following
 61    * arguments will be passed to the |Observe| method:
...
 63    *   aTopic   - The string defined by NS_PREFBRANCH_PREFCHANGE_OBSERVER_ID
120 #define NS_PREFBRANCH_PREFCHANGE_TOPIC_ID "nsPref:changed"

QA note: you can verify this by checking to see that the document is internally
consistent.

Comment 1

[Ali Ebrahim]

Attachment: Making documentation consistent with code

The patch just changes the documentation to be consistent with the code.

Comment 2

[Ali Ebrahim]

Comment on attachment 145358 [details] [diff] [review]
Making documentation consistent with code

This is a one-liner no-risk code documentation fix that should probably make it
into 1.7.

Comment 3

[Mike Kaply [:mkaply]]

Comment on attachment 145358 [details] [diff] [review]
Making documentation consistent with code

a=mkaply

Comment 4

[Christian :Biesinger (don't email me, ping me on IRC)]

Checking in modules/libpref/public/nsIPrefBranchInternal.idl;
/cvsroot/mozilla/modules/libpref/public/nsIPrefBranchInternal.idl,v  <-- 
nsIPrefBranchInternal.idl
new revision: 1.11; previous revision: 1.10
done