Re: [Nautilus-list] eel documentation

[Darin Adler <darin bentspoon com>]

On 12/8/01 11:07 AM, "Mikael Lindberg" <d94ml efd lth se> wrote:

> Is there any documentation of eel?

There are many documentation-style comments before some of the eel functions
in the sources. In other projects, such as gnome-vfs, these are extracted by
gtk-doc to make documentation. But other than that, there is no
documentation.

It helps to understand eel if you realize that historically it is just 1/2
of the libnautilus-private library, split into a separate package to make
dependencies clearer. It doesn't have any more documentation than the rest
of libnautilus-private does.

On the other hand, documenting it more would not be an onerous task. Most of
it is fairly simple, and I'm available to answer questions for someone who's
either using it or writing documentation for it.

By the way, contributors who would be willing to contribute documentation
are just as welcome as people who want to write code.

    -- Darin