Re: CORBA interfaces undocumented?

[Michael Meeks <michael ximian com>]

Hi Murray,

On Fri, 2002-03-29 at 13:28, Murray Cumming wrote:
> No they don't, because the wrappers seem to be far more than just sugar,

	Often they are yes - and this is a problem.

> don't contain adequate comments, and bear little resemblance to the
> CORBA interfaces. That's why I have to ask all these questions.

	:-) sure.

> APIs should be documented. If Bonobo is CORBA API then the CORBA API
> should be documented.

	We use gtk-doc - like comments in the IDL to document each method - at
least, we try to. However at last look there is no way to build those
comments into Docbook easily, gtk-doc didn't handle IDL last time I
looked.

	But you're right the documentation is somewhat sparse in several places
- which makes life hard. What particular APIs are you having problems
with ?

	Regards,

		Michael.

-- 
 mmeeks gnu org  <><, Pseudo Engineer, itinerant idiot