Closed Bug 638276 Opened 13 years ago Closed 13 years ago

Update (and fix) nsTextEditorState.h documentation

Categories

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

defect
Not set
normal

Tracking

()

RESOLVED FIXED
mozilla2.0

People

(Reporter: mounir, Assigned: ehsan.akhgari)

Details

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.
Oh, I assume it's painful because mAnonDivObserver doesn't exist.
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?
http://hg.mozilla.org/mozilla-central/rev/3404db11fbea
Assignee: nobody → ehsan
Status: NEW → RESOLVED
Closed: 13 years ago
Resolution: --- → FIXED
Target Milestone: --- → mozilla2.0
(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 ;)
Component: DOM → DOM: Core & HTML
You need to log in before you can comment on or make changes to this bug.