Generating Seed Documentation from Gobject introspection : RooJSolutions

Published 2010-02-25 23:18:00

Job hunting is going pretty slowly (if anyone at ubuntu is listening hint hint ;) , and projects are pretty much done, so I get to work on really cool stuff.

While developing in seed is pretty productive, hunting down the documentation, or discovering the right method to use has been one of the roadblocks I have been bumping up against. So wondered yesterday how well the introspection code in seed works.

Turns out, that the built in Seed.introspection() method is pretty pointless, even after committing a few extra features, I discovered it was never going to be much help. However girepostory has it's on gir/typelib file, so you can call introspection directly.

After a few experiments, I worked out to inspect basically every method, and class in Gnome. Hence there is now full documentation for every Gnome Class that seed can talk to (this does not include libxml however, as it does not use gir to talk to that.

Support for doc comments (by parsing the gir files) is there, but the machines I build on unfortunately have rather old gir files, which do not include all the docs comments.

This code could be very easily refactored to generate docs for pygi, gjs or vala.. or any other gir based binding..

For your viewing pleasure..

Seed Gnome Documentation

If it's not working, it's probably as I'm working on it and have broken it.

The code is in my seed subversion repo the key files that do all the work are JSDOC/Introspection.js, and docs.js The rest of the code just deals with Template parsing and handling (/docs/* are the templates)

To run it you need cutting edge seed (which can take quite a while to set up as it depends on a recent webkit build)

Enjoy.

Mentioned By:
live.gnome.org : Seed - GNOME Live! (600 referals)
live.gnome.org : GObjectIntrospection/BindingsDocumentation - GNOME Live! (442 referals)
google.com : gobject introspection documentation (21 referals)
planet-php.org : Planet PHP (12 referals)
google.com : seed documentation (11 referals)
google.com : generating seed (8 referals)
google.com : alan introspection javascript seed (3 referals)
google.com : gnome seed gobject blog (2 referals)
google.com : php introspection (2 referals)
live.gnome.org : Diff for "Seed" - GNOME Live! (1 referals)
google.com : generating php docs comments (1 referals)
google.com : gnome seed working slowly (1 referals)
google.com : series seed documentation (1 referals)
google.com : who created generating seeds (1 referals)
blog.astrumfutura.com : Maugrim The Reaper's Blog (1 referals)

Related

Generating Seed Documentation from Gobject introspection

Comments

Add Your Comment

Follow us

Blog Latest

Twitter - @Roojs