Re: Documentation layout suggestion



Lee Mallabone wrote:
> 
> Hi,
> 
> Something that I've found useful when browsing java documentation is that
> the docs for each class state the names of any classes which further
> extend (subclass) the documented class.
> 
> So my question is, could something like that be added to the gtk+ docs?
> 
> I ask because it took me a few minutes to figure out the purpose of
> GtkRange in the hierarchy of things. Only after a bit of browsing around
> did I find out that it is used by Gtk[HV]Scale... Would have been nice to
> be able to see that at-a-glance, hence my suggestion.

Yes, it is quite a good idea. But of course you only get the widgets in
the same package that extend the class. You won't get Gnome widgets etc.

We do have the complete hierarchy at the end of the GTK+ docs.

It would be fairly easy to add the subclasses into the docs, but I'm not
sure where they should go. Should they go in the 'Object Hierarchy'
like this:


    GtkObject
     +----GtkWidget
           +----GtkRange
                 +----GtkScale
                 +----GtkScrollbar

I think that looks fairly good. It would be nice to make the current
class stand out a bit more.

Damon




[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]