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


Le jeudi 02 octobre 2008 Ã 18:22 +0100, Martyn Russell a Ãcrit :
Luca Ferretti wrote:
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:

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

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 - 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.

We decided to go with gtk-doc.

I have added the initial work here for libtracker-common in the docs/

But it can't currently be built :-/

Some files are missing.

(I don't know if you were aware about that.)


directory. This is what it looks like so far:

This is a temporary version of documentation to see how it looks.
This will be extended over time.

What do we need to do to get this integrated into l.g.o?

Attachment: signature.asc
Description: Ceci est une partie de message =?ISO-8859-1?Q?num=E9riquement?= =?ISO-8859-1?Q?_sign=E9e?=

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