[cairo] [PATCHES] documentation update
nis.martensen at web.de
Thu Mar 8 13:14:27 PST 2012
On Wed, Mar 07, 2012 at 07:07:21PM +0100, Uli Schlachter wrote:
> Patches 1, 4 (and others): I don't have much clue about gtk-doc, but these
> definitely looks better with the colon. :-)
The since tags are not recognized by gtk-doc without the colon.
> Patch 6: What exactly is the confusion? Is this fixing a doxygen-ism?
This fixes a gtk-doc warning:
src/cairo/doc/public/../../src/cairo-gl.h:58: warning: Symbol
name not found at the start of the comment block.
> Patch 10: Another instance of "no clue about gtk-doc", but I think it should be
> safe to assume you know what you are doing.
Gtk-doc on my system pretty-prints the <programlisting>s with syntax
highlighting and prepended line numbers, and does not preserve all white
space. In some cases the tag is used for non-code snippets where white
space preservation is wanted, and line numbers are not. The <screen> tag
fits these cases better.
> > One of the patches (ensure compatibility spelling) also
> > adapts code, not sure if this is ok.
> I assume this refers to patch 12?
> Patch 12: Looks good. Only touches private headers and if the result compiles,
> everything is fine...
Did not test.
> This series has 22 patches, but the git patch files say "[PATCH xx/25]", where
> three patches lost?
Intentionally not sent. They were my initial attempts at this:
> > doc/public/cairo-sections.txt still wants an update. I'm not sure
> > about the correct sections for the "unused" symbols. Who takes care
> > of that?
> Good question. Tell me when you figured it out. :-)
More information about the cairo