diff options
author | Matthias Clasen <matthiasc@src.gnome.org> | 2002-05-02 22:28:50 +0000 |
---|---|---|
committer | Matthias Clasen <matthiasc@src.gnome.org> | 2002-05-02 22:28:50 +0000 |
commit | 7b168e71eb186d996e797f8100265ea9413c457a (patch) | |
tree | 2b09337525ff4b5d64e7cbcf2c5eaf1f64104368 /docs | |
parent | 252c9c1230ee63281d8559ae1ce8f7117d71a3b9 (diff) | |
download | gtk+-7b168e71eb186d996e797f8100265ea9413c457a.tar.gz |
Doc updates.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/reference/ChangeLog | 12 | ||||
-rw-r--r-- | docs/reference/gdk/gdk-sections.txt | 1 | ||||
-rw-r--r-- | docs/reference/gdk/tmpl/gdkdisplay.sgml | 4 | ||||
-rw-r--r-- | docs/reference/gdk/tmpl/gdkscreen.sgml | 15 | ||||
-rw-r--r-- | docs/reference/gdk/tmpl/x_interaction.sgml | 25 |
5 files changed, 30 insertions, 27 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 734f9c7b36..17b88f436a 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,4 +1,14 @@ -2002-05-02 Matthias Clasen <maclas@gmx.de> +2002-05-03 Matthias Clasen <maclas@gmx.de> + + * gdk/gdk-sections.txt: Remove gdk_screen_use_virtual_screen. + + * gdk/tmpl/gdkscreen.sgml: Updates. + + * gdk/tmpl/gdkdisplay.sgml: Document GdkDisplay. + + * gdk/tmpl/x_interaction.sgml: Document GDK_DISPLAY_XDISPLAY, + GDK_SCREEN_XDISPLAY, GDK_SCREEN_XSCREEN, GDK_SCREEN_XNUMBER, + gdk_font_lookup_for_display. * gdk/Makefile.am (GTKDOC_CFLAGS, GTKDOC_LIBS): set these. diff --git a/docs/reference/gdk/gdk-sections.txt b/docs/reference/gdk/gdk-sections.txt index 1298b56583..8c111d67bf 100644 --- a/docs/reference/gdk/gdk-sections.txt +++ b/docs/reference/gdk/gdk-sections.txt @@ -167,7 +167,6 @@ gdk_screen_get_height_mm gdk_screen_close gdk_screen_list_visuals gdk_screen_get_toplevel_windows -gdk_screen_use_virtual_screen gdk_screen_get_n_monitors gdk_screen_get_monitor_geometry gdk_screen_get_monitor_at_point diff --git a/docs/reference/gdk/tmpl/gdkdisplay.sgml b/docs/reference/gdk/tmpl/gdkdisplay.sgml index 7962c66399..65504c1934 100644 --- a/docs/reference/gdk/tmpl/gdkdisplay.sgml +++ b/docs/reference/gdk/tmpl/gdkdisplay.sgml @@ -30,10 +30,10 @@ controls the keyboard/mouse pointer grabs and a set of <type>GdkScreen</type>s <!-- ##### STRUCT GdkDisplay ##### --> <para> - +The <structname>GdkDisplay</structname> struct is the GDK representation +of an X display. All its fields are private and should not be accessed directly. </para> -@parent_instance: <!-- ##### FUNCTION gdk_open_display ##### --> <para> diff --git a/docs/reference/gdk/tmpl/gdkscreen.sgml b/docs/reference/gdk/tmpl/gdkscreen.sgml index db18d3e0b5..d423d554e1 100644 --- a/docs/reference/gdk/tmpl/gdkscreen.sgml +++ b/docs/reference/gdk/tmpl/gdkscreen.sgml @@ -24,12 +24,10 @@ form a large screen area. <!-- ##### STRUCT GdkScreen ##### --> <para> -This is a currently just a placeholder typedef for the first argument of -the @window_at_pointer function in #GdkPointerHooks. It will be used -when GDK gets multihead support. +The <structname>GdkScreen</structname> struct is the GDK representation of a + physical screen. All its fields are private and should not be accessed directly. </para> -@parent_instance: <!-- ##### FUNCTION gdk_screen_get_default_colormap ##### --> <para> @@ -185,15 +183,6 @@ when GDK gets multihead support. @Returns: -<!-- ##### FUNCTION gdk_screen_use_virtual_screen ##### --> -<para> - -</para> - -@screen: -@Returns: - - <!-- ##### FUNCTION gdk_screen_get_n_monitors ##### --> <para> diff --git a/docs/reference/gdk/tmpl/x_interaction.sgml b/docs/reference/gdk/tmpl/x_interaction.sgml index 4174cb4af4..292f8518cc 100644 --- a/docs/reference/gdk/tmpl/x_interaction.sgml +++ b/docs/reference/gdk/tmpl/x_interaction.sgml @@ -78,10 +78,10 @@ Returns the X pixmap belonging to a #GdkPixmap. <!-- ##### MACRO GDK_DISPLAY_XDISPLAY ##### --> <para> - +Returns the display of a #GdkDisplay. </para> -@display: +@display: a #GdkDisplay. <!-- ##### MACRO GDK_DRAWABLE_XDISPLAY ##### --> @@ -149,26 +149,30 @@ Returns the X colormap belonging to a #GdkColormap. <!-- ##### MACRO GDK_SCREEN_XDISPLAY ##### --> <para> - +Returns the display of a #GdkScreen. </para> -@screen: +@screen: a #GdkScreen. +@Returns: an Xlib <type>Display*</type>. <!-- ##### MACRO GDK_SCREEN_XNUMBER ##### --> <para> - +Returns the index of a #GdkScreen. </para> -@screen: +@screen: a #GdkScreen +@Returns: the position of @screen among the screens of + its display. <!-- ##### MACRO GDK_SCREEN_XSCREEN ##### --> <para> - +Returns the screen of a #GdkScreen. </para> -@screen: +@screen: a #GdkScreen +@Returns: an Xlib <type>Screen*</type>. <!-- ##### MACRO GDK_VISUAL_XVISUAL ##### --> @@ -370,7 +374,7 @@ a #GdkWindow or a #GdkFont. <!-- ##### MACRO gdk_font_lookup ##### --> <para> -Obtains the #GdkFont for the given Xlib pixmap ID, or %NULL if no #GdkPixmap has +Obtains the #GdkFont for the given Xlib font ID, or %NULL if no #GdkFont has been created for @xid. </para> @@ -379,7 +383,8 @@ been created for @xid. <!-- ##### MACRO gdk_font_lookup_for_display ##### --> <para> - +Obtains the #GdkFont for the given Xlib font ID on @display, or %NULL if no +#GdkFont has been created for @xid. </para> @display: |