summaryrefslogtreecommitdiff
path: root/gtk/gtkprinter.c
diff options
context:
space:
mode:
authorJavier Jardón <jjardon@gnome.org>2010-05-16 02:11:16 +0200
committerJavier Jardón <jjardon@gnome.org>2010-05-16 02:11:16 +0200
commit19448b971264e0373553ae06a55522d1f7e7dfd2 (patch)
treef5ebf0e12be0f812ba95c32b047ec646e16985a7 /gtk/gtkprinter.c
parentb00a09de11e8dc1f16f137560f9aebf065584eb1 (diff)
downloadgtk+-19448b971264e0373553ae06a55522d1f7e7dfd2.tar.gz
Move documentation to inline comments: GtkPrinter
Diffstat (limited to 'gtk/gtkprinter.c')
-rw-r--r--gtk/gtkprinter.c19
1 files changed, 19 insertions, 0 deletions
diff --git a/gtk/gtkprinter.c b/gtk/gtkprinter.c
index 1ffaaf5bcb..928896ab1f 100644
--- a/gtk/gtkprinter.c
+++ b/gtk/gtkprinter.c
@@ -31,6 +31,25 @@
#include "gtkprintjob.h"
#include "gtkalias.h"
+
+/**
+ * SECTION:gtkprinter
+ * @Short_description: Represents a printer
+ * @Title: GtkPrinter
+ *
+ * A #GtkPrinter object represents a printer. You only need to
+ * deal directly with printers if you use the non-portable
+ * #GtkPrintUnixDialog API.
+ *
+ * A #GtkPrinter allows to get status information about the printer,
+ * such as its description, its location, the number of queued jobs,
+ * etc. Most importantly, a #GtkPrinter object can be used to create
+ * a #GtkPrintJob object, which lets you print to the printer.
+ *
+ * Printing support was added in GTK+ 2.10.
+ */
+
+
#define GTK_PRINTER_GET_PRIVATE(o) \
(G_TYPE_INSTANCE_GET_PRIVATE ((o), GTK_TYPE_PRINTER, GtkPrinterPrivate))