[Mono-docs-list] Re: [Gtk-sharp-list] Gnome.NET tutorial.
Miguel de Icaza
28 Feb 2003 12:55:41 -0500
> On Fri, 2003-02-28 at 07:17, Miguel de Icaza wrote:
> > Also, porting some of the code samples to Gtk# should help iron out
> > the bugs in the binding.
> Would these ported samples be best placed in Gnome.NET or in the API docs?
The samples of the tutorial are more tutorial-focused, and will probably
touch on various things.
That being said, I think we should have a few samples in the
documentation, because I feel that is a bug in general with Gtk
documentation: that looking up the docs has never helped someone who is
a newcomer start to write code.
> At the very least, I think it would be great to be able to refer/display a full sample from the API docs.
> The current directory structure of doc/ and sample/ means this is not easily possible, I think?
> This is something I'd like to change; do people have any ideas on how we could best integrate everything?
I am open to any ideas an changes about this. But please keep in mind
that this is no substitute for small code snippets that show the
functionality of the class.
> Does the monodoc browser currently have facilities for displaying/rendering full code examples?
> If so, we could probably just pull in referenced files from sample/ when running 'make' in doc/
If it does not, we should make sure it does. It is very easy to handle
(it requires XSLT work, but that is all it needs).
Pulling automatically samples from the disk is something am not too
excited about. For technical reasons and because it does not blend
nicely into the explanation for a single method, single class.
In .NET they have a separate section called `QuickStart' that has
pointers to these, for separate tasks.