Inclusion of documentation in introspection data?

John (J5) Palmieri johnp at redhat.com
Mon Oct 24 11:52:07 PDT 2005


On Mon, 2005-10-24 at 20:07 +0200, Julien PUYDT wrote:
> John (J5) Palmieri a écrit :
> > I was thinking of adding it as an annotation.  In fact python can do
> > this without spec changes if we want to.  We eventually wanted to have
> > it so you could do print proxy_obj.__doc__ and get documentation.  The
> > biggest problem is bandwidth.  Good documentation can easily become
> > bigger than the introspect data itself.  Do we want to go down that
> > road?  
> 
> I was thinking about that when you asked about seeing the dbus interface 
> for gnomemeeting 2.0 in introspection form... I realized that my current 
> file also documents what the arguments are, and what the method 
> call/signal is about.
> 
> The introspection xml loses that.

Anyone can add an annotation to their introspect format.  The format
needs to be a good citizen however and not pass megabytes of info over
the wire :-)

--

John (J5) Palmieri <johnp at redhat.com>



More information about the dbus mailing list