Cai Qian <[EMAIL PROTECTED]> writes:

>> (2) Review and complete the API reference manuals. This will probably
>>     need some programming skills but some simple proof-reading would
>>     already help a lot. We have tried to keep the API reference
>>     manuals uptodate during development. We did however often only add
>>     stubs. What's missing here is at least some short introductions
>>     into all the new sections that have been added.
>>     I will try to upload an uptodate snapshot of the docs at
>>     http://developer.gimp.org/api/2.0/ later today. It would be very
>>     nice if we could find a volunteer who could help us to improve the
>>     docs for 2.2. If you are interested, please let me know.
> I am quite interested about this, I have some programming skills in
> C and GTK, but am not quite familiar with GIMP code. So I want to
> know if that ok, or how to start?

I've uploaded the current state of the docs to
http://developer.gimp.org/api/2.0/. There's a lot of room for
improvements here and I don't really care where you would want to
start. One of the things I'd like to see being done is to make sure
that each section has at least a short description. If you have a look
at for example http://developer.gimp.org/api/2.0/libgimp/ you will
notice that quite a few sections lack this short description. That
would perhaps be a good start.

About the technical details: The API reference manuals are created
using gtk-doc. The docs are located in the devel-docs directory of the
GIMP source tree. There's a README.gtkdoc in there which tries to
explain the concepts of gtk-doc. If you have further questions, please
let me know.

To get back to the example I gave above. In order to fix the problem
of the missing descriptions, you would edit the file
devel-docs/libgimp/tmpl/gimpbrush.sgml and fill in the missing bits at
the top where it says:

<!-- ##### SECTION Short_Description ##### -->

Editing the API reference manual is pretty much straight-forward. You
need almost no knowledge of Docbook/XML. It does however help to have
some experience writing GIMP plug-ins. But of course you can always
ask and this might be a good way to learn the GIMP API.

Gimp-developer mailing list

Reply via email to