Re: gobject introspection annotations

[Stefan Kost <ensonic hora-obscura de>]

hi,


Iain Nicol schrieb:
> Hi,
> 
> I'm adding gobject introspection annotations to Epiphany, because it
> needs some.  My problem is I don't know how to get gtk-doc to recognise
> them.  Instead of gtk-doc understanding and describing the annotations,
> gtk-doc creates links to FOLDOC; the symptoms are like in
> <https://bugzilla.gnome.org/show_bug.cgi?id=598732>.
> 
> I've compiled gtk-doc from git.  In particular, the ``annotations'' test
> that comes with gtk-doc works fine.  Yet I don't know how to get it to
> work for Epiphany.
> 
> Is there any particular makefile or autofoo stuff or flags I should look
> at? 

Not at all.

> Where could the problem lie? -mkdb?

Have you added
    <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
to your master document? See tests/annotations/docs/tester-docs.xml near to the
end. The xslt does a fallback if the local links do not exist.

Stefan


> 
> 
> Epiphany's doc build process seems fairly normal.  It has gtk-doc build
> and run a scanner.  Then the templates are created:
>   cd . && gtkdoc-mktmpl --module=epiphany
> then:
>   cd . && gtkdoc-mkdb --module=epiphany --source-dir=../.. \
>                      --output-format=xml --sgml-mode --output-format=xml
> and then:
>   cd ./html && gtkdoc-mkhtml epiphany ../epiphany-docs.sgml
> and finally:
>   cd . && gtkdoc-fixxref --module-dir=html \
>                          --html-dir=/usr/local/share/gtk-doc/html 
> 
> There's loads of output from all the commands, but the only relevant
> thing I could see was the following warning from -mkhtml:
> 
>   In gtk-doc.xsl: For acronym (transfer none) no value found! 
> 
> 
> Thanks,