Bug 31968
| Summary: | Document::incDOMTreeVersion() and domTreeVersion() need documentation | ||
|---|---|---|---|
| Product: | WebKit | Reporter: | Eric Seidel (no email) <eric> |
| Component: | WebCore Misc. | Assignee: | Nobody <webkit-unassigned> |
| Status: | RESOLVED WONTFIX | ||
| Severity: | Normal | CC: | ahmad.saleem792, ap, cdumez, darin, mjs, rniwa |
| Priority: | P2 | ||
| Version: | 528+ (Nightly build) | ||
| Hardware: | All | ||
| OS: | All | ||
Eric Seidel (no email)
Document::incDOMTreeVersion() and domTreeVersion() need documentation
void incDOMTreeVersion() { ++m_domtree_version; }
unsigned domTreeVersion() const { return m_domtree_version; }
I have no idea when these are supposed to be called, or if we're calling them in all the places we should be. Document.h needs to document these methods.
They were added by mjs in http://trac.webkit.org/changeset/8037
| Attachments | ||
|---|---|---|
| Add attachment proposed patch, testcase, etc. |
Alexey Proskuryakov
The DOM tree version needs to be changed each time the DOM tree changes. Do you have any specific non-obvious examples that should be documented?
The DOM tree version is used to invalidate HTMLCollection caches and XPathResult, so any modification that can affect either should change the version. That's easy to discover by searching through WebCore code.
Ahmad Saleem
We still have this: https://searchfox.org/wubkat/source/Source/WebCore/dom/Document.h#1142
Do we need to do anything here?
Ryosuke Niwa
We don't need a documentation for this. The purpose of these tree versions are self explanatory.