[Gtk-sharp-list] gtk# docs assembly information

Peter Williams peter@newton.cx
Fri, 03 Dec 2004 18:12:46 -0500

On Fri, 2004-12-03 at 14:42 -0800, Todd Berman wrote:
> Well, the issue is that the generator/parser in gtk# pics up if a
> method/class/property/event/whatever has been deprecated in gtk+, and
> emits an [Obsolete] attribute on top of it. So the class/call/thing
> exists in the dll, but it is recommended not to write new code that uses
> it.
> The issue is that there is no way (I think) for monodoc to show that.

Ah, you're right. I don't think it would be very hard to add a check for
that: see monodoc/browser/assembly.cs:MonoImpInfo(). I might try and
throw together a patch for this later.

> On the subject of obsoletes, I know there is a way to put a message
> inside the attribute to be pushed out at compile time. Generally, this
> message gives you a bit of info on what to replace your code with, or
> why the method is obsolete. Should we somehow get those in? Most of the
> things that are deprecated in gtk+ have at least a bit of info as to
> what to use instead.

I think that info is stored in the source code and GtkDoc docs, not the
headers which monodoc scans. So extracting it could be pretty hard;
entering it manually into the foo-api.xml files might be easier.


Peter Williams                          peter@newton.cx

"[Ninjas] are cool; and by cool, I mean totally sweet."
                              -- REAL Ultimate Power