summaryrefslogtreecommitdiff
path: root/gdk-pixbuf/gdk-pixdata.c
diff options
context:
space:
mode:
authorMatthias Clasen <matthiasc@src.gnome.org>2001-12-20 23:09:29 +0000
committerMatthias Clasen <matthiasc@src.gnome.org>2001-12-20 23:09:29 +0000
commit3aabcd28912f6bbd11a12d9975085fd440172f72 (patch)
tree24be6c8b365408aedb3bf8c7819ee0a45d49417e /gdk-pixbuf/gdk-pixdata.c
parentecfd1affa659ca01e6298e5999e6949e23eb3e45 (diff)
downloadgtk+-3aabcd28912f6bbd11a12d9975085fd440172f72.tar.gz
More precise documentation about underscores and mnemonics. (#66380)
* gtk/gtklabel.c (gtk_label_new_with_mnemonic), gtk/gtkbutton.c (gtk_button_new_with_mnemonic): More precise documentation about underscores and mnemonics. (#66380) * gtk/gtktextiter.c (gtk_text_iter_backward_word_starts): Fix cyclic reference in docs. * gtk/gtklabel.c (gtk_label_set_justify): Correct documentation of default value. (#65402) * gtk/gtkmain.c (gtk_set_locale, gtk_disable_set_locale): Markup fixes. * gdk-pixbuf-io.c, gdk-pixbuf-animation.c, gdk-pixbuf-data.c, gdk-pixbuf-loader.c, gdk-pixbuf-scale.c, gdk-pixbuf-util.c, gdk-pixdata.c: Markup fixes. * gtk/text_widget.sgml: More precise wording. (#63388) * gtk/tmpl/gtksignal.sgml (GTK_SIGNAL_OFFSET): Add docs. * gtk/resources.sgml: Fix markup of mail URLs. * gtk/tmpl/gtkpaned.sgml, gtk/tmpl/gtkobject.sgml: Markup fixes. * gtk/tmpl/gtktoolbar.sgml (gtk_toolbar_{prepend,append}_element): Expand documentation. (#60471) * gtk/tmpl/gtkmain.sgml: Remove misleading information about gtk_set_locale(). (#65758)
Diffstat (limited to 'gdk-pixbuf/gdk-pixdata.c')
-rw-r--r--gdk-pixbuf/gdk-pixdata.c25
1 files changed, 14 insertions, 11 deletions
diff --git a/gdk-pixbuf/gdk-pixdata.c b/gdk-pixbuf/gdk-pixdata.c
index c2b87e8402..b5d0835f9b 100644
--- a/gdk-pixbuf/gdk-pixdata.c
+++ b/gdk-pixbuf/gdk-pixdata.c
@@ -578,8 +578,8 @@ save_rle_decoder (GString *gstring,
* Generates C source code suitable for compiling images directly
* into programs.
*
- * Gtk+ ships with a program called gdk-pixbuf-csource which offers
- * a cmdline interface to this functions.
+ * GTK+ ships with a program called <command>gdk-pixbuf-csource</command>
+ * which offers a cmdline interface to this functions.
*
* Returns: a newly-allocated string containing the C source form
* of @pixdata.
@@ -820,28 +820,31 @@ gdk_pixdata_to_csource (GdkPixdata *pixdata,
/**
* gdk_pixbuf_new_from_inline:
* @data_length: Length in bytes of the @data argument
- * @data: Byte data containing a serialized GdkPixdata structure
+ * @data: Byte data containing a serialized #GdkPixdata structure
* @copy_pixels: Whether to copy the pixel data, or use direct pointers
* @data for the resulting pixbuf
- * @error: GError return location, may be %NULL to ignore errors
+ * @error: #GError return location, may be %NULL to ignore errors
*
* Create a #GdkPixbuf from a flat representation that is suitable for
* storing as inline data in a program. This is useful if you want to
* ship a program with images, but don't want to depend on any
* external files.
*
- * Gtk+ ships with a program called gdk-pixbuf-csource which allows
- * for conversion of #GdkPixbufs into such a inline representation.
- * In almost all cases, you should pass the --raw flag to
- * gdk-pixbuf-csource. A sample invocation would be:
+ * GTK+ ships with a program called <command>gdk-pixbuf-csource</command>
+ * which allows for conversion of #GdkPixbufs into such a inline representation.
+ * In almost all cases, you should pass the <option>--raw</option> flag to
+ * <command>gdk-pixbuf-csource</command>. A sample invocation would be:
*
+ * <informalexample><programlisting>
* gdk-pixbuf-csource --raw --name=myimage_inline myimage.png
+ * </programlisting></informalexample>
*
* For the typical case where the inline pixbuf is read-only static data,
* you don't need to copy the pixel data unless you intend to write to
- * it, so you can pass %FALSE for @copy_pixels. (If you pass --rle to
- * gdk-pixbuf-csource, a copy will be made even if @copy_pixels is
- * %FALSE, so using this option is generally a bad idea.)
+ * it, so you can pass %FALSE for @copy_pixels. (If you pass
+ * <option>--rle</option> to <command>gdk-pixbuf-csource</command>, a copy
+ * will be made even if @copy_pixels is %FALSE, so using this option is
+ * generally a bad idea.)
*
* If you create a pixbuf from const inline data compiled into your
* program, it's probably safe to ignore errors, since things will