Move documentation to inline comments: GtkPrintUnixDialog

diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index 8bd6d8cea44aedd3ba2d286c1cdb6254f191b79a..35d3e2ae275ba612e35d390301076be0deb44ac9 100644 (file)
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -85,6 +85,7 @@ gtkprinter.sgml
 gtkprintjob.sgml
 gtkprintoperation.sgml
 gtkprintsettings.sgml
+gtkprintunixdialog.sgml
 gtkprogressbar.sgml
 gtkradioaction.sgml
 gtkradiobutton.sgml

diff --git a/docs/reference/gtk/tmpl/gtkprintunixdialog.sgml b/docs/reference/gtk/tmpl/gtkprintunixdialog.sgml
deleted file mode 100644 (file)
index d5155ad..0000000
--- a/docs/reference/gtk/tmpl/gtkprintunixdialog.sgml
+++ /dev/null
@@ -1,317 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GtkPrintUnixDialog
-
-<!-- ##### SECTION Short_Description ##### -->
-A print dialog
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-GtkPrintUnixDialog implements a print dialog for platforms
-which don't provide a native print dialog, like Unix. It can 
-be used very much like any other GTK+ dialog, at the cost of 
-the portability offered by the <link 
-linkend="gtk-High-level-Printing-API">high-level printing API</link>
-</para>
-<para>
-In order to print something with #GtkPrintUnixDialog, you need
-to use gtk_print_unix_dialog_get_selected_printer() to obtain
-a #GtkPrinter object and use it to construct a #GtkPrintJob using
-gtk_print_job_new().
-</para>
-<para>
-#GtkPrintUnixDialog uses the following response values:
-<variablelist>
-  <varlistentry><term>%GTK_RESPONSE_OK</term>
-    <listitem><para>for the "Print" button</para></listitem>
-  </varlistentry>
-  <varlistentry><term>%GTK_RESPONSE_APPLY</term>
-    <listitem><para>for the "Preview" button</para></listitem>
-  </varlistentry>
-  <varlistentry><term>%GTK_RESPONSE_CANCEL</term>
-    <listitem><para>for the "Cancel" button</para></listitem>
-  </varlistentry>
-</variablelist>
-</para>
-
-<!-- FIXME example here -->
-
-<para>
-Printing support was added in GTK+ 2.10.
-</para>
-
-<refsect2 id="GtkPrintUnixDialog-BUILDER-UI"><title>GtkPrintUnixDialog as GtkBuildable</title>
-<para>
-The GtkPrintUnixDialog implementation of the GtkBuildable interface exposes its
-@notebook internal children with the name "notebook".
-</para>
-<example>
-<title>A <structname>GtkPrintUnixDialog</structname> UI definition fragment.</title>
-<programlisting><![CDATA[
-<object class="GtkPrintUnixDialog" id="dialog1">
-  <child internal-child="notebook">
-    <object class="GtkNotebook" id="notebook">
-      <child>
-        <object class="GtkLabel" id="tabcontent">
-        <property name="label">Content on notebook tab</property>
-        </object>
-      </child>
-      <child type="tab">
-        <object class="GtkLabel" id="tablabel">
-          <property name="label">Tab label</property>
-        </object>
-        <packing>
-          <property name="tab_expand">False</property>
-          <property name="tab_fill">False</property>
-        </packing>
-      </child>
-    </object>
-  </child>
-</object>
-]]></programlisting>
-</example>
-</refsect2>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-#GtkPageSetupUnixDialog, #GtkPrinter, #GtkPrintJob
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### SECTION Image ##### -->
-
-
-<!-- ##### STRUCT GtkPrintUnixDialog ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GtkPrintUnixDialog:current-page ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkPrintUnixDialog:embed-page-setup ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkPrintUnixDialog:has-selection ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkPrintUnixDialog:manual-capabilities ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkPrintUnixDialog:page-setup ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkPrintUnixDialog:print-settings ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkPrintUnixDialog:selected-printer ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkPrintUnixDialog:support-selection ##### -->
-<para>
-
-</para>
-
-<!-- ##### FUNCTION gtk_print_unix_dialog_new ##### -->
-<para>
-
-</para>
-
-@title: 
-@parent: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_print_unix_dialog_set_page_setup ##### -->
-<para>
-
-</para>
-
-@dialog: 
-@page_setup: 
-
-
-<!-- ##### FUNCTION gtk_print_unix_dialog_get_page_setup ##### -->
-<para>
-
-</para>
-
-@dialog: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_print_unix_dialog_set_current_page ##### -->
-<para>
-
-</para>
-
-@dialog: 
-@current_page: 
-
-
-<!-- ##### FUNCTION gtk_print_unix_dialog_get_current_page ##### -->
-<para>
-
-</para>
-
-@dialog: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_print_unix_dialog_set_settings ##### -->
-<para>
-
-</para>
-
-@dialog: 
-@settings: 
-
-
-<!-- ##### FUNCTION gtk_print_unix_dialog_get_settings ##### -->
-<para>
-
-</para>
-
-@dialog: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_print_unix_dialog_get_selected_printer ##### -->
-<para>
-
-</para>
-
-@dialog: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_print_unix_dialog_add_custom_tab ##### -->
-<para>
-
-</para>
-
-@dialog: 
-@child: 
-@tab_label: 
-
-
-<!-- ##### FUNCTION gtk_print_unix_dialog_set_support_selection ##### -->
-<para>
-
-</para>
-
-@dialog: 
-@support_selection: 
-
-
-<!-- ##### FUNCTION gtk_print_unix_dialog_get_support_selection ##### -->
-<para>
-
-</para>
-
-@dialog: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_print_unix_dialog_set_has_selection ##### -->
-<para>
-
-</para>
-
-@dialog: 
-@has_selection: 
-
-
-<!-- ##### FUNCTION gtk_print_unix_dialog_get_has_selection ##### -->
-<para>
-
-</para>
-
-@dialog: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_print_unix_dialog_set_embed_page_setup ##### -->
-<para>
-
-</para>
-
-@dialog: 
-@embed: 
-
-
-<!-- ##### FUNCTION gtk_print_unix_dialog_get_embed_page_setup ##### -->
-<para>
-
-</para>
-
-@dialog: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_print_unix_dialog_get_page_setup_set ##### -->
-<para>
-
-</para>
-
-@dialog: 
-@Returns: 
-
-
-<!-- ##### ENUM GtkPrintCapabilities ##### -->
-<para>
-An enum for specifying which features the print dialog should offer.
-If neither %GTK_PRINT_CAPABILITY_GENERATE_PDF nor 
-%GTK_PRINT_CAPABILITY_GENERATE_PS is specified, GTK+ assumes that all 
-formats are supported.
-</para>
-
-@GTK_PRINT_CAPABILITY_PAGE_SET: Print dialog will offer printing even/odd pages.
-@GTK_PRINT_CAPABILITY_COPIES: Print dialog will allow to print multiple copies.
-@GTK_PRINT_CAPABILITY_COLLATE: Print dialog will allow to collate multiple copies.
-@GTK_PRINT_CAPABILITY_REVERSE: Print dialog will allow to print pages in reverse order.
-@GTK_PRINT_CAPABILITY_SCALE: Print dialog will allow to scale the output.
-@GTK_PRINT_CAPABILITY_GENERATE_PDF: The program will send the document to 
-    the printer in PDF format
-@GTK_PRINT_CAPABILITY_GENERATE_PS: The program will send the document to 
-    the printer in Postscript format
-@GTK_PRINT_CAPABILITY_PREVIEW: Print dialog will offer a preview
-@GTK_PRINT_CAPABILITY_NUMBER_UP: Print dialog will offer printing multiple 
-    pages per sheet. Since 2.12
-@GTK_PRINT_CAPABILITY_NUMBER_UP_LAYOUT: Print dialog will allow to rearrange 
-    pages when printing multiple pages per sheet. Since 2.14
-
-<!-- ##### FUNCTION gtk_print_unix_dialog_set_manual_capabilities ##### -->
-<para>
-
-</para>
-
-@dialog: 
-@capabilities: 
-
-
-<!-- ##### FUNCTION gtk_print_unix_dialog_get_manual_capabilities ##### -->
-<para>
-
-</para>
-
-@dialog: 
-@Returns: 
-
-

diff --git a/gtk/gtkprinter.h b/gtk/gtkprinter.h
index f2c18c10c21c76511a12e76be79d6202b4b341cd..a9e8736d1c2b0cddc0e2677c14d38d1161d3d7eb 100644 (file)
--- a/gtk/gtkprinter.h
+++ b/gtk/gtkprinter.h
@@ -34,6 +34,28 @@ G_BEGIN_DECLS
 /* Note, this type is manually registered with GObject in gtkprinter.c
  * If you add any flags, update the registration as well!
  */
+/**
+ * GtkPrintCapabilities:
+ * @GTK_PRINT_CAPABILITY_PAGE_SET: Print dialog will offer printing even/odd pages.
+ * @GTK_PRINT_CAPABILITY_COPIES: Print dialog will allow to print multiple copies.
+ * @GTK_PRINT_CAPABILITY_COLLATE: Print dialog will allow to collate multiple copies.
+ * @GTK_PRINT_CAPABILITY_REVERSE: Print dialog will allow to print pages in reverse order.
+ * @GTK_PRINT_CAPABILITY_SCALE: Print dialog will allow to scale the output.
+ * @GTK_PRINT_CAPABILITY_GENERATE_PDF: The program will send the document to
+ *   the printer in PDF format
+ * @GTK_PRINT_CAPABILITY_GENERATE_PS: The program will send the document to
+ *   the printer in Postscript format
+ * @GTK_PRINT_CAPABILITY_PREVIEW: Print dialog will offer a preview
+ * @GTK_PRINT_CAPABILITY_NUMBER_UP: Print dialog will offer printing multiple
+ *   pages per sheet. Since 2.12
+ * @GTK_PRINT_CAPABILITY_NUMBER_UP_LAYOUT: Print dialog will allow to rearrange
+ *   pages when printing multiple pages per sheet. Since 2.14
+ *
+ * An enum for specifying which features the print dialog should offer.
+ * If neither %GTK_PRINT_CAPABILITY_GENERATE_PDF nor
+ * %GTK_PRINT_CAPABILITY_GENERATE_PS is specified, GTK+ assumes that all
+ * formats are supported.
+ */
 typedef enum
 {
   GTK_PRINT_CAPABILITY_PAGE_SET         = 1 << 0,

diff --git a/gtk/gtkprintunixdialog.c b/gtk/gtkprintunixdialog.c
index f4a5049f60dcf4b1739899f9911475f2f1fc32b5..e3515a01d62b78694f423fd1c175286b1df85389 100644 (file)
--- a/gtk/gtkprintunixdialog.c
+++ b/gtk/gtkprintunixdialog.c
@@ -61,6 +61,77 @@
 #include "gtkprivate.h"
 #include "gtktypebuiltins.h"
 
+
+/**
+ * SECTION:gtkprintunixdialog
+ * @Short_description: A print dialog
+ * @Title: GtkPrintUnixDialog
+ * @See_also: #GtkPageSetupUnixDialog, #GtkPrinter, #GtkPrintJob
+ *
+ * GtkPrintUnixDialog implements a print dialog for platforms
+ * which don't provide a native print dialog, like Unix. It can
+ * be used very much like any other GTK+ dialog, at the cost of
+ * the portability offered by the
+ * <link linkend="gtk-High-level-Printing-API">high-level printing API</link>
+ *
+ * In order to print something with #GtkPrintUnixDialog, you need
+ * to use gtk_print_unix_dialog_get_selected_printer() to obtain
+ * a #GtkPrinter object and use it to construct a #GtkPrintJob using
+ * gtk_print_job_new().
+ *
+ * #GtkPrintUnixDialog uses the following response values:
+ * <variablelist>
+ *   <varlistentry><term>%GTK_RESPONSE_OK</term>
+ *     <listitem><para>for the "Print" button</para></listitem>
+ *   </varlistentry>
+ *   <varlistentry><term>%GTK_RESPONSE_APPLY</term>
+ *     <listitem><para>for the "Preview" button</para></listitem>
+ *   </varlistentry>
+ *   <varlistentry><term>%GTK_RESPONSE_CANCEL</term>
+ *     <listitem><para>for the "Cancel" button</para></listitem>
+ *   </varlistentry>
+ * </variablelist>
+ *
+ * <!-- FIXME example here -->
+ *
+ * Printing support was added in GTK+ 2.10.
+ *
+ * <refsect2 id="GtkPrintUnixDialog-BUILDER-UI">
+ * <title>GtkPrintUnixDialog as GtkBuildable</title>
+ * <para>
+ * The GtkPrintUnixDialog implementation of the GtkBuildable interface exposes its
+ * @notebook internal children with the name "notebook".
+ *
+ * <example>
+ * <title>A <structname>GtkPrintUnixDialog</structname> UI definition fragment.</title>
+ * <programlisting><![CDATA[
+ * <object class="GtkPrintUnixDialog" id="dialog1">
+ *   <child internal-child="notebook">
+ *     <object class="GtkNotebook" id="notebook">
+ *       <child>
+ *         <object class="GtkLabel" id="tabcontent">
+ *         <property name="label">Content on notebook tab</property>
+ *         </object>
+ *       </child>
+ *       <child type="tab">
+ *         <object class="GtkLabel" id="tablabel">
+ *           <property name="label">Tab label</property>
+ *         </object>
+ *         <packing>
+ *           <property name="tab_expand">False</property>
+ *           <property name="tab_fill">False</property>
+ *         </packing>
+ *       </child>
+ *     </object>
+ *   </child>
+ * </object>
+ * ]]></programlisting>
+ * </example>
+ * </para>
+ * </refsect2>
+ */
+
+
 #define EXAMPLE_PAGE_AREA_SIZE 110
 #define RULER_DISTANCE 7.5
 #define RULER_RADIUS 2