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

Todd Berman tberman@off.net
Fri, 03 Dec 2004 14:42:52 -0800


On Fri, 2004-12-03 at 17:22 -0500, Peter Williams wrote:
> On Fri, 2004-12-03 at 14:14 -0800, Todd Berman wrote:
> > And I believe Mike was talking about monodoc displaying some fu that
> > shows that a specific method/class/thing is Obsolete.
> 
> Yeah, it'll do that; the assembler uses Reflection to check that
> documented methods/properties/whatever actually exist in the DLL.
> 

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.

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.


--Todd