[gtk+] Move documentation to inline comments: GtkPaperSize



commit 945e97e50539497bbb0bf5ddc6f8eb8889681b39
Author: Javier Jardón <jjardon gnome org>
Date:   Mon Sep 27 03:49:49 2010 +0200

    Move documentation to inline comments: GtkPaperSize

 docs/reference/gtk/tmpl/.gitignore        |    1 +
 docs/reference/gtk/tmpl/gtkpapersize.sgml |  308 -----------------------------
 gtk/gtkpapersize.c                        |   21 ++
 gtk/gtkpapersize.h                        |   41 ++++
 4 files changed, 63 insertions(+), 308 deletions(-)
---
diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index 45d4c04..9a71d2d 100644
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -17,6 +17,7 @@ gtkmessagedialog.sgml
 gtkobject.sgml
 gtkorientable.sgml
 gtkpagesetupunixdialog.sgml
+gtkpapersize.sgml
 gtkprinter.sgml
 gtkradioaction.sgml
 gtkradiobutton.sgml
diff --git a/gtk/gtkpapersize.c b/gtk/gtkpapersize.c
index 3d81fd9..7601aba 100644
--- a/gtk/gtkpapersize.c
+++ b/gtk/gtkpapersize.c
@@ -34,6 +34,27 @@
 
 #include "paper_names_offsets.c"
 
+
+/**
+ * SECTION:gtkpapersize
+ * @Short_description: Support for named paper sizes
+ * @Title: GtkPaperSize
+ * @See_also:#GtkPageSetup
+ *
+ * GtkPaperSize handles paper sizes. It uses the standard called
+ * <ulink url="http://www.pwg.org/standards.html";>"PWG 5101.1-2002 PWG: Standard for Media Standardized Names"</ulink>
+ * to name the paper sizes (and to get the data for the page sizes).
+ * In addition to standard paper sizes, GtkPaperSize allows to
+ * construct custom paper sizes with arbitrary dimensions.
+ *
+ * The #GtkPaperSize object stores not only the dimensions (width
+ * and height) of a paper size and its name, it also provides
+ * default <link linkend="print-margins">print margins</link>.
+ *
+ * Printing support has been added in GTK+ 2.10.
+ */
+
+
 struct _GtkPaperSize
 {
   const PaperInfo *info;
diff --git a/gtk/gtkpapersize.h b/gtk/gtkpapersize.h
index a3ef2f1..864eb38 100644
--- a/gtk/gtkpapersize.h
+++ b/gtk/gtkpapersize.h
@@ -36,12 +36,53 @@ typedef struct _GtkPaperSize GtkPaperSize;
 #define GTK_TYPE_PAPER_SIZE    (gtk_paper_size_get_type ())
 
 /* Common names, from PWG 5101.1-2002 PWG: Standard for Media Standardized Names */
+/**
+ * GTK_PAPER_NAME_A3:
+ *
+ * Name for the A4 paper size.
+ */
 #define GTK_PAPER_NAME_A3 "iso_a3"
+
+/**
+ * GTK_PAPER_NAME_A4:
+ *
+ * Name for the A4 paper size.
+ */
 #define GTK_PAPER_NAME_A4 "iso_a4"
+
+/**
+ * GTK_PAPER_NAME_A5:
+ *
+ * Name for the A5 paper size.
+ */
 #define GTK_PAPER_NAME_A5 "iso_a5"
+
+/**
+ * GTK_PAPER_NAME_B5:
+ *
+ * Name for the B5 paper size.
+ */
 #define GTK_PAPER_NAME_B5 "iso_b5"
+
+/**
+ * GTK_PAPER_NAME_LETTER:
+ *
+ * Name for the Letter paper size.
+ */
 #define GTK_PAPER_NAME_LETTER "na_letter"
+
+/**
+ * GTK_PAPER_NAME_EXECUTIVE:
+ *
+ * Name for the Executive paper size.
+ */
 #define GTK_PAPER_NAME_EXECUTIVE "na_executive"
+
+/**
+ * GTK_PAPER_NAME_LEGAL:
+ *
+ * Name for the Legal paper size.
+ */
 #define GTK_PAPER_NAME_LEGAL "na_legal"
 
 GType gtk_paper_size_get_type (void) G_GNUC_CONST;



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