[webkit-dev] Documenting common null pointer errors

[Maciej Stachowiak]

On Aug 11, 2009, at 3:03 PM, Adam Barth wrote:

> In reviewing patches, I feel like I'm commonly pointing out
> DOMWindow::frame and Document::frame, etc, can be null in some
> circumstances.  Would it be useful to have a diagram of the major
> objects (Page, Frame, DOMWindow, Document, etc) somewhere on
> webkit.org that shows their relation, which links can be null, and
> which objects change / are preserved during navigation?
>
> If so, I'm happy to create this with my current knowledge, and
> hopefully folks with more experience will add parts that I don't know.
> What's the best medium to make this easy to update in the future?
> SVG?  ASCII art?

It would be useful to make such a diagram. Also hard to make it  
accurate! I'd be happy to provide information and advice to anyone  
working on this.

I'm not sure what format to use to capture the data. In the abstract,  
my preference would be a plain text file that could be transformed  
into diagrams in various chosen formats, but that depends on what kind  
of data we capture.

Regards,
Maciej