<!doctype article PUBLIC "-//Davenport//DTD DocBook V3.0//EN" []> <article class="techreport" id="todo"> <artheader> <title>Status of the gnome-libs documentation</title> <copyright> <year>1999</year> <holder>The Free Software Foundation</holder> </copyright> </artheader> <!-- Introduction --> <sect1> <title>Introduction</title> <para> This document describes the current status of the gnome-libs documentation. This is intended to give people an idea of what is missing and what requires work. Please consider contributing to the gnome-libs documentation effort, as it is very important to have complete reference and programming documentation for GNOME. </para> <para> GNOME uses the gtk-doc framework for documentation. This allows us to insert reference documentation directly into the source files, by using comments in a special format, and later extract it automatically to produce the final reference documentation. You should install the gtk-doc package if you want to generate documentation from the source files. </para> </sect1> <!-- Documentation for libgnome --> <sect1> <title>Documentation for libgnome</title> <para> This section describes the current status of the documentation for libgnome. Libgnome has the GUI-independent part of the core GNOME libraries. </para> <variablelist> <varlistentry> <term>gnome-config</term> <listitem> <para> Complete. Note that since most of the functions in here are called via macros, there have to be partially duplicated comment strings. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-dentry</term> <listitem> <para> Complete. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-exec</term> <listitem> <para> Complete. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-fileconvert</term> <listitem> <para> Complete. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-help</term> <listitem> <para> Complete. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-history</term> <listitem> <para> Complete. Some comments may need a bit of reformatting. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-i18n</term> <listitem> <para> Complete. Some comments may need a bit of reformatting. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-magic</term> <listitem> <para> <emphasis>Done (in the gnome-mime docs).</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-metadata</term> <listitem> <para> Complete. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-mime</term> <listitem> <para> Complete. Some comments may need a bit of reformatting. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-mime-info</term> <listitem> <para> Complete. Some comments may need a bit of reformatting. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-paper</term> <listitem> <para> Complete. Some comments may need a bit of reformatting. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-popt</term> <listitem> <para> Complete. Some comments may need a bit of reformatting. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-regex</term> <listitem> <para> Complete. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-remote</term> <listitem> <para> Complete. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-score</term> <listitem> <para> Complete. Some comments may need a bit of reformatting. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-sound</term> <listitem> <para> Complete. Some comments may need a bit of reformatting. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-triggers</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-url</term> <listitem> <para> Complete. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-util</term> <listitem> <para> Function documentation is complete. Some comments may need a bit of reformatting. However, the macros in <filename>gnome-util.h</filename> do not seem to have been documented yet. </para> </listitem> </varlistentry> <varlistentry> <term>gnomelibs-init</term> <listitem> <para> Complete. However, the variables in <filename>libgnome.h</filename> do not seem to have been documented yet. </para> </listitem> </varlistentry> </variablelist> </sect1> <!-- Documentation for libgnomeui --> <sect1> <title>Documentation for libgnomeui</title> <para> This section describes the current status of the documentation for libgnomeui. Libgnomeui has the GUI parts of the core GNOME libraries. </para> <variablelist> <varlistentry> <term>gnome-about</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-animator</term> <listitem> <para> <emphasis>Incomplete.</emphasis> Some comments need a bit of reformatting. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-app-helper</term> <listitem> <para> <emphasis>Incomplete.</emphasis> Note that the macros in <filename>gnome-app-helper.h</filename> also need documentation. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-app-util</term> <listitem> <para> <emphasis>Incomplete.</emphasis> Some comments need a bit of reformatting. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-app</term> <listitem> <para> Complete. Some comments may need a bit of reformatting. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-appbar</term> <listitem> <para> Complete. Some comments may need a bit of reformatting. There is a macro in <filename>gnome-appbar.h</filename> that is not documented. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-calculator</term> <listitem> <para> <emphasis>Incomplete.</emphasis> I am not sure if the way it documents the macro in <filename>gnome-calculator.h</filename> is correct. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-canvas</term> <listitem> <para> Complete. Some comments may need a bit of reformatting. However, the macros in <filename>gnome-canvas.h</filename> are lacking documentation. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-canvas-image</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-canvas-load</term> <listitem> <para> Complete. Some comments may need a bit of reformatting. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-canvas-polygon</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-canvas-rect-ellipse</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-canvas-text</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-canvas-util</term> <listitem> <para> Complete. The final documentation needs images with the nice diagrams that are drawn in ASCII art in <filename>gnome-canvas-util.h</filename>. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-canvas-widget</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-client</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-color-picker</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-dateedit</term> <listitem> <para> Complete. Some comments may need a bit of reformatting. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-dentry-edit</term> <listitem> <para> <emphasis>Incomplete.</emphasis> The macros in <filename>gnome-dentry-edit.h</filename> also need documentation. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-dialog</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-dialog-util</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-dns</term> <listitem> <para> Complete. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-dock</term> <listitem> <para> <emphasis>Complete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-dock-band</term> <listitem> <para> <emphasis>Complete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-dock-item</term> <listitem> <para> <emphasis>Complete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-dock-layout</term> <listitem> <para> <emphasis>Complete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-entry</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-file-entry</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-font-picker</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-font-selector</term> <listitem> <para> <emphasis>Incomplete.</emphasis> This module is deprecated. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-geometry</term> <listitem> <para> Complete. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-guru</term> <listitem> <para> <emphasis>Incomplete.</emphasis> This module is immature and will be replaced soon. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-href</term> <listitem> <para> Complete. Some comments may need a bit of reformatting. This module is marked as immature. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-ice</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-icon-entry</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-icon-item</term> <listitem> <para> Complete. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-icon-list</term> <listitem> <para> Complete. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-icon-sel</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-icon-text</term> <listitem> <para> Complete. Some comments may need a bit of reformatting. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-init</term> <listitem> <para> Complete. Some comments may need a bit of reformatting. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-less</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-mdi</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-mdi-child</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-mdi-generic-child</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-mdi-session</term> <listitem> <para> Complete. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-messagebox</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-number-entry</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-paper-selector</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-pixmap</term> <listitem> <para> <emphasis>Incomplete.</emphasis> Some comments may need a bit of reformatting. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-pixmap-entry</term> <listitem> <para> <emphasis>Incomplete.</emphasis> Some comments may need a bit of reformatting. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-popup-help</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-popup-menu</term> <listitem> <para> <emphasis>Incomplete.</emphasis> Some comments may need a bit of reformatting. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-preferences</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-procbar</term> <listitem> <para> <emphasis>Incomplete.</emphasis> This module is marked as immature. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-properties</term> <listitem> <para> <emphasis>Incomplete.</emphasis> This module is marked as immature. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-property-entries</term> <listitem> <para> <emphasis>Incomplete.</emphasis> This module is marked as immature. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-propertybox</term> <listitem> <para> Complete. Some comments may need a bit of reformatting. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-scores</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-spell</term> <listitem> <para> Complete. Some comments may need a bit of reformatting. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-startup</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-stock</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnome-types</term> <listitem> <para> <emphasis>Incomplete.</emphasis> This consists only of a header file with a few type definitions. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-uidefs</term> <listitem> <para> <emphasis>Incomplete.</emphasis> This consists only of a header file with macro definitions. </para> </listitem> </varlistentry> <varlistentry> <term>gnome-winhints</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gnometypes</term> <listitem> <para> <emphasis>Incomplete.</emphasis> This does not have a proper header file. </para> </listitem> </varlistentry> <varlistentry> <term>gtk-clock</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gtk-ted</term> <listitem> <para> <emphasis>Incomplete.</emphasis> This module is deprecated. </para> </listitem> </varlistentry> <varlistentry> <term>gtkcauldron</term> <listitem> <para> Complete. However, the macros in <filename>gtkcauldron.h</filename> do not have documentation. Some comments may need a bit of reformatting. </para> </listitem> </varlistentry> <varlistentry> <term>gtkdial</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>gtkpixmapmenuitem</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> </variablelist> </sect1> <!-- Documentation for libgnorba --> <sect1> <title>Documentation for libgnorba</title> <para> This section describes the current status of the documentation for libgnorba. Libgnorba provides the GNOME name server for CORBA and integration of ORBit and GNOME/GTK+. </para> <variablelist> <varlistentry> <term>gnorba</term> <listitem> <para> Complete. Some comments may need a bit of reformatting. </para> </listitem> </varlistentry> </variablelist> </sect1> <!-- Documentation for libart_lgpl --> <sect1> <title>Documentation for libart_lgpl</title> <para> Libart is a sophisticated library for manipulation and rendering of vector paths. It provides antialiasing and alpha compositing, and also utility data structures like sorted vector paths and microtile arrays. Libart is used as a framework for the GNOME Canvas and printing system. </para> <variablelist> <varlistentry> <term>art_affine</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>art_alphagamma</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>art_bpath</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>art_gray_svp</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>art_misc</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>art_pixbuf</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>art_rect</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>art_rect_svp</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>art_rect_uta</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>art_rgb</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>art_rgb_affine</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>art_rgb_affine_private</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>art_rgb_bitmap_affine</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>art_rgb_pixbuf_affine</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>art_rgb_rgba_affine</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>art_rgb_svp</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>art_svp</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>art_svp_ops</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>art_svp_render_aa</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>art_svp_vpath</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>art_svp_vpath_stroke</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>art_svp_wind</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>art_uta</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>art_uta_ops</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>art_uta_rect</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>art_uta_svp</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>art_uta_vpath</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>art_vpath</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>art_vpath_bpath</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>art_vpath_svp</term> <listitem> <para> <emphasis>Incomplete.</emphasis> </para> </listitem> </varlistentry> </variablelist> </sect1> </article>