638276 - Update (and fix) nsTextEditorState.h documentation

Status: RESOLVED FIXED

(Core :: DOM: Core & HTML, defect)

Description

[Mounir Lamouri (:mounir)]

Documentation is great but outdated one is somewhat painful.

I think this paragraph at least is outdated:
 *  * The editor's cached value.  This value is stored in the mCachedValue member.
 *    It is used to improve the performance of append operations to the text
 *    control.  A mutation observer stored in the mAnonDivObserver has the job of
 *    invalidating this cache when the anonymous contect containing the value is
 *    changed.

Comment 1

[Mounir Lamouri (:mounir)]

Oh, I assume it's painful because mAnonDivObserver doesn't exist.

Comment 2

[(no longer active)]

Good catch.  I renamed mAnonDivObserver to mMutationObserver while working on this class initially and forgot to update the docuemntation.  Is there anything more to fix here?

Comment 3

[(no longer active)]

http://hg.mozilla.org/mozilla-central/rev/3404db11fbea

Comment 4

[Mounir Lamouri (:mounir)]

(In reply to comment #2)
> Good catch.  I renamed mAnonDivObserver to mMutationObserver while working on
> this class initially and forgot to update the docuemntation.  Is there anything
> more to fix here?

I didn't see anything else but I wasn't reading that documentation to find mistakes ;)