Re: Shell documentation/gir?

["Jasper St. Pierre" <jstpierre mecheye net>]

On Sun, Aug 12, 2012 at 8:30 PM, Amy C <mathematical coffee gmail com> wrote:
> Hi all,
>
> (Hopefully the list is up and running again).
>
> I'm trying to track down documentation for Shell (e.g.
> Shell.GenericContianer()). I found the Shell-0.1.typelib in
> /usr/lib/gnome-shell and generated a .gir via
>
>     g-ir-generate --includedir=/usr/lib/gnome-shell
> /usr/lib/gnome-shell/Shell-0.1.typelib > Shell-0.1.gir
>
> I then attempted to generate documentation via
>
>     g-ir-doc-tool Shell-0.1.gir -o shell-docs   # generate
> documentation into folder shell-docs
>     yelp-build html shell-docs # to turn into html
>
> First it complained about not being able to find .gir files for
> TelepathyLogger-0.2 and TelepathyGLib-0.12, so I generate those .gir
> files similarly.
>
> Then it complained about
>
>     Shell-0.1.gir: Incompatible version 1.0 (supported: 1.2)
>
> so I modified the .gir file and changed `<repository version="1.0"` to
> `<repository version="1.2"` as a workaround. (I'm on GNOME 3.2; maybe
> I'll try later on GNOME 3.4 to see if that fixes things)
>
> Now it says that an assertion failed: c_symbol_prefix is not None
> (full trace at the end).

Seems to be a gobject-introspection bug.

> So, does anyone know
>
> * Is the Shell documentation online at developer.gnome.org like the
> St, Clutter, ... documentation? (I couldn't find it), OR

http://developer.gnome.org/shell/unstable/ShellGenericContainer.html

> * Can anyone successfully generate these docs and send them to me?
> (Perhaps my "1.0" -> "1.2" workaround was not sufficient to generate
> the docs and my versions of everything are too old in GNOME 3.2?)
>
> cheers!
>
> Traceback (most recent call last):
>   File "/usr/bin/g-ir-doc-tool", line 46, in <module>
>     sys.exit(doc_main(sys.argv))
>   File "/usr/lib/gobject-introspection/giscanner/docmain.py", line 89,
> in doc_main
>     generator.parse(args[1])
>   File "/usr/lib/gobject-introspection/giscanner/docmain.py", line 41, in parse
>     self.transformer = Transformer.parse_from_gir(filename, extra_include_dirs)
>   File "/usr/lib/gobject-introspection/giscanner/transformer.py", line
> 191, in parse_from_gir
>     self._parse_include(filename)
>   File "/usr/lib/gobject-introspection/giscanner/transformer.py", line
> 208, in _parse_include
>     self.register_include(include)
>   File "/usr/lib/gobject-introspection/giscanner/transformer.py", line
> 131, in register_include
>     self._parse_include(filename)
>   File "/usr/lib/gobject-introspection/giscanner/transformer.py", line
> 208, in _parse_include
>     self.register_include(include)
>   File "/usr/lib/gobject-introspection/giscanner/transformer.py", line
> 131, in register_include
>     self._parse_include(filename)
>   File "/usr/lib/gobject-introspection/giscanner/transformer.py", line
> 203, in _parse_include
>     parser.parse(filename)
>   File "/usr/lib/gobject-introspection/giscanner/girparser.py", line
> 61, in parse
>     self.parse_tree(tree)
>   File "/usr/lib/gobject-introspection/giscanner/girparser.py", line
> 71, in parse_tree
>     self._parse_api(tree.getroot())
>   File "/usr/lib/gobject-introspection/giscanner/girparser.py", line
> 172, in _parse_api
>     method(node)
>   File "/usr/lib/gobject-introspection/giscanner/girparser.py", line
> 479, in _parse_boxed
>     c_symbol_prefix=node.attrib.get(_cns('symbol-prefix')))
>   File "/usr/lib/gobject-introspection/giscanner/ast.py", line 881, in __init__
>     assert c_symbol_prefix is not None
> AssertionError
> _______________________________________________
> gnome-shell-list mailing list
> gnome-shell-list gnome org
> https://mail.gnome.org/mailman/listinfo/gnome-shell-list



-- 
  Jasper