[cairo] [PATCH] doc: fix some broken references

[Andrea Canciani]

On Mon, Jan 10, 2011 at 1:20 PM, Maarten Bosmans <mkbosmans at gmail.com> wrote:
> 2010/12/30 Andrea Canciani <ranma42 at gmail.com>:
>> On Thu, Dec 30, 2010 at 11:01 AM, Maarten Bosmans <mkbosmans at gmail.com>
>> wrote:
>>> 2010/12/29 Andrea Canciani <ranma42 at gmail.com>:
>>>>> Am 28.12.2010 13:50, Maarten Bosmans wrote:
>>>>>> This fixes some obvious mistakes in the docs.
>>>>
>>>> The attachment is a patch that should probably be merged with yours.
>>>
>>> Attached is a new version of my patch and a modified version of yours,
>>> with duplicate changes removed
>>>
>>>> Cairo docs would use some more love and I have a couple of items in my
>>>> TODO list, but I haven't fixed them yet.
>>>
>>> Any suggestions? I was thinking of adding some more cross references
>>> ('see also' links) between relevant functions.
>>
>> Straight from my TODO list:
>>  - document filtering, gradients, get_data/flush/mark_dirty
>>
>> We should document the definition of the gradients (or at least give a
>> reference to the PDF specification aka ISO32000, where their definition
>> is mathematically sound and detailed enough).
>>
>> cairo_image_surface_get_data() should reference cairo_surface_flush(),
>> which
>> must be called before reading/writing data, and
>> cairo_surface_mark_dirty(),
>> which must be called if the content of the data has been modified.
>> Similar functions in other backends (cairo_win32_surface_get_dc,
>> cairo_win32_surface_get_image, ...) should receive a similar treatment.
>>
>> cairo_filter_t and cairo_extend_t would use a more complete definition
>> (what does each extend mode mean for gradients, expecially when the
>> stops don't cover the whole 0..1 range? etc etc)
>
> Can my patches be applied by someone then? You can then work on top of that.

I pushed this branch:
http://cgit.freedesktop.org/~ranma42/cairo/log/?h=wip/docs

If the commits:
http://cgit.freedesktop.org/~ranma42/cairo/commit/?h=wip/docs&id=01c66d34c387a2d2b9114a9fccc7491ad7ff1315
http://cgit.freedesktop.org/~ranma42/cairo/commit/?h=wip/docs&id=ae23a2628ae1737662ff8a11a57cf9c0e223a7f9
http://cgit.freedesktop.org/~ranma42/cairo/commit/?h=wip/docs&id=37439d813621d991989e62f6d15b710834d478c2

look good to you, I'll push them to master.

Please notice that I have intentionally left this change:
http://cgit.freedesktop.org/~ranma42/cairo/commit/?h=wip/docs&id=ddd94d56edcf0eb62cc9522e71a7cc6adeb4a321
behind, because I think that the correct fix is probably to add the
DEVICE_FINISHED status.

I have done minor changes to your patches, merged my changes in
"Fix some broken references and gtk-doc warnings" and extended the commit
messages.

Andrea