logo       
Google Custom Search
    AddThis Social Bookmark Button
-->

Re: Inclusion of documentation in introspection data?: msg#00143

Subject: Re: Inclusion of documentation in introspection data?
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-H+wXaHxf7aLQT0dZR+AlfA@xxxxxxxxxxxxxxxx>

_______________________________________________
dbus mailing list
dbus-PD4FTy7X32lNgt0PjOBp9y5qC8QIuHrW@xxxxxxxxxxxxxxxx
http://lists.freedesktop.org/mailman/listinfo/dbus



<Prev in Thread] Current Thread [Next in Thread>