[gtk+] Move documentation to inline comments: GtkPrinter



commit 19448b971264e0373553ae06a55522d1f7e7dfd2
Author: Javier Jardón <jjardon gnome org>
Date:   Sun May 16 02:11:16 2010 +0200

    Move documentation to inline comments: GtkPrinter

 docs/reference/gtk/tmpl/.gitignore      |    1 +
 docs/reference/gtk/tmpl/gtkprinter.sgml |  336 -------------------------------
 gtk/gtkprinter.c                        |   19 ++
 gtk/gtkprinter.h                        |   13 ++
 4 files changed, 33 insertions(+), 336 deletions(-)
---
diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index 123a234..c870daa 100644
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -6,6 +6,7 @@ gtkmessagedialog.sgml
 gtkobject.sgml
 gtkorientable.sgml
 gtkpagesetupunixdialog.sgml
+gtkprinter.sgml
 gtkradioaction.sgml
 gtkrecentaction.sgml
 gtkrecentchooserwidget.sgml
diff --git a/gtk/gtkprinter.c b/gtk/gtkprinter.c
index 1ffaaf5..928896a 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))
 
diff --git a/gtk/gtkprinter.h b/gtk/gtkprinter.h
index e2cb534..cb5bcbd 100644
--- a/gtk/gtkprinter.h
+++ b/gtk/gtkprinter.h
@@ -119,6 +119,19 @@ gboolean                 gtk_printer_get_hard_margins      (GtkPrinter       *pr
                                                             gdouble          *left,
                                                             gdouble          *right);
 
+/**
+ * GtkPrinterFunc:
+ * @printer: a #GtkPrinter
+ * @data: user data passed to gtk_enumerate_printers()
+ *
+ * The type of function passed to gtk_enumerate_printers().
+ * Note that you need to ref @printer, if you want to keep
+ * a reference to it after the function has returned.
+ *
+ * Returns: %TRUE to stop the enumeration, %FALSE to continue
+ *
+ * Since: 2.10
+ */
 typedef gboolean (*GtkPrinterFunc) (GtkPrinter *printer,
 				    gpointer    data);
 



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]