After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 100187 - improve developer documentation
improve developer documentation
Status: RESOLVED FIXED
Product: GIMP
Classification: Other
Component: Help
git master
Other All
: Normal enhancement
: Future
Assigned To: GIMP Bugs
GIMP Bugs
Depends on: 156271
Blocks:
 
 
Reported: 2002-12-03 00:26 UTC by Akkana Peck
Modified: 2005-08-15 01:37 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
First pass: create descriptions for each category under libgimp. (14.83 KB, patch)
2002-12-03 00:29 UTC, Akkana Peck 		committed Details | Review

Description Akkana Peck 2002-12-03 00:26:09 UTC 
I volunteered on #gimp to help with developer documentation, particularly
the libgimp stuff in devel-docs.  Filing this bug to hold patches and track
things that need to be documented.
Comment 1 Akkana Peck 2002-12-03 00:29:01 UTC 
Created attachment 12697 [details] [review]
First pass: create descriptions for each category under libgimp.
Comment 2 Akkana Peck 2002-12-03 00:33:06 UTC 
Let me know if all the "Functions for ..." seem too redundant.  I
started doing that because the existing descriptions did, but when
every entry starts with "functions" it might read better if I removed
most of them.

Also, it's probably a good idea to have someone glance through these
and make sure I got them right ...
Comment 3 Sven Neumann 2002-12-03 10:07:52 UTC 
The patch looks good so I've applied it. We can always improve the
descriptions later. For the moment, it's more important to have
something at all.
Comment 4 Sven Neumann 2002-12-03 10:41:15 UTC 
IMO we should port the devel-doc framework to gtk-doc version 0.10 and
switch from SGML to XML. GTK+ and GLib are doing this in the HEAD
branches at the moment. Perhaps you take a look at this stuff and if
you like this idea, let me know and I'll try to update the framework
accordingly.
Comment 5 Sven Neumann 2003-01-06 15:19:39 UTC 
I've done some more work on the documentation of libgimpwidgets, Mitch
documented libgimpmodule and Nathan improved the libgimp docs lately.
There is of course still a lot more work to do ...
Comment 6 Dave Neary 2003-07-26 10:33:41 UTC 
Bumping a bunch of enhancement requests which will not be done by the feature
freeze to Future. 

Dave.
Comment 7 alexander.winston 2004-01-24 04:59:11 UTC 
Adding the PATCH keyword.
Comment 8 Sven Neumann 2004-01-25 12:30:16 UTC 
Removing the PATCH keyword since the patch has been applied and this
report now serves as a tracking bug.
Comment 9 weskaggs 2005-03-01 19:02:19 UTC 
I don't actually see any sense in keeping this bug report open.  Suggest closing
as FIXED.