Re: Hackfest topics: gtk+ docs

[Jose Aliste <jose aliste gmail com>]

HI,

On Fri, Oct 15, 2010 at 4:14 PM, Stefan Kost <ensonic hora-obscura de> wrote:
> Am 12.10.2010 23:32, schrieb Johannes Schmid:
>> Hi!
>>
>> Just a reminder from the gtk+ meeting for the hackfest.
>
> Unfortunately my employer does not seem to sponsor me comming :/
>
>> Writing down
>> here so it doesn't get lost:
>>
>> * Prefered way of API docs/examples is docbook/in-code documentation
>> because it is easier to update
>
> xi:including them is quite easy and has the benefit that the examples could be
> even compiled to test that they work. I belive we have a mechanism in gstreamer
> to put some comment markers into the examples and a perl-script that extracts
> enclosed parts for the docs. This way you could omit some boilerplate from the docs.
>
> Unfortunately syntax highlighting in docbook is still docbook processor
> specific. In gtk-doc I postprocess the generated html and colorize it (yes, ugly).
>
>>
>> * Better gtkdoc-css for the docs
>
> If there are idea, I would love to hear about them. Also if someone is good in
> css, there is a long standing bug that is quite annoying:
> https://bugzilla.gnome.org/show_bug.cgi?id=618379 - Navigation is hiding anchors
> title.
>
This bug is so annoying, so I asked my brother to fix this (His name
is Rodrigo and He is an expert in css), and now the corrected html and
css are attached in the bug. It works well in every browser we tested
(opera, firefox, chrome)

Greetings,

josé

>>
>> * cookbock-style instead of tutorials (clutter cookbook might be an
>> example)
>>
>> Regards,
>> Johannes
>>
>>
>>
>> _______________________________________________
>> gnome-doc-list mailing list
>> gnome-doc-list gnome org
>> http://mail.gnome.org/mailman/listinfo/gnome-doc-list
>
> _______________________________________________
> gnome-doc-list mailing list
> gnome-doc-list gnome org
> http://mail.gnome.org/mailman/listinfo/gnome-doc-list
>