Re: [Tracker] *** Maybe Spam *** Re: Documentation

[Luca Ferretti <elle uca libero it>]

Il giorno gio, 02/10/2008 alle 12.04 +0100, Martyn Russell ha scritto:
> Luca Ferretti wrote:
> > Il giorno lun, 29/09/2008 alle 16.40 +0100, Martyn Russell ha scritto:
> > > Jamie McCracken wrote:

<snip>
 
> > And it's the standard GNOME way to document the APIS.
> >
> > Plus, of course, you can distribute docs inside the tracker sources and
> > read/search with Devhelp
>
> We are not documenting the APIs we are documenting architecture and
> HOWTOs for building 3rd party components into Tracker. This feels
> outside the scope of what l.g.o is for. Maybe I am wrong?


There are a lot of stuff on l.g.o, internally added using gtk-doc or
externally linked, see for example the guide to write Deskbar plugins

http://www.k-d-w.org/deskbar/new-style_modules.html

I think there are two options:
     A. use gtk-doc - if you are planning to provide API refs and
        general introduction/howto/example in the same document
     B. use live.gnome.org - if you are just planning to write a simple
        howto for 3rd party components without any API refs

However IMHO tracker have to document public APIs, like any other well
behaving GNOME/GTK+/Glib project, so we'll need gtk-doc sooner or later.