AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity

docs: don't use <type> tags

Browse Source 
Use # syntax where appropriate.
This commit is contained in:
William Jon McCann 2014-01-28 00:06:30 -05:00
parent 05655c5bfa
commit 0a1d276f4f
15 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
gdk/gdkevents.h
View File

@ -165,8 +165,8 @@ typedef void (*GdkEventFunc) (GdkEvent *event,
/**
* GdkXEvent:
*
* Used to represent native events (<type>XEvent</type>s for the X11
* backend, <type>MSG</type>s for Win32).
* Used to represent native events (XEvents for the X11
* backend, MSGs for Win32).
*/
typedef void GdkXEvent; /* Can be cast to window system specific
* even type, XEvent on X11, MSG on Win32.
@ -391,7 +391,7 @@ typedef enum
*
* Specifies the kind of crossing for #GdkEventCrossing.
*
* See the X11 protocol specification of <type>LeaveNotify</type> for
* See the X11 protocol specification of LeaveNotify for
* full details of crossing event generation.
*/
typedef enum

4
gdk/x11/gdkcursor-x11.c
View File

@ -291,7 +291,7 @@ _gdk_x11_display_get_cursor_for_type (GdkDisplay *display,
*
* Returns the display of a #GdkCursor.
*
* Return value: (transfer none): an Xlib <type>Display*</type>.
* Return value: (transfer none): an Xlib Display*.
**/
Display *
gdk_x11_cursor_get_xdisplay (GdkCursor *cursor)
@ -307,7 +307,7 @@ gdk_x11_cursor_get_xdisplay (GdkCursor *cursor)
*
* Returns the X cursor belonging to a #GdkCursor.
*
* Return value: an Xlib <type>Cursor</type>.
* Return value: an Xlib Cursor.
**/
Cursor
gdk_x11_cursor_get_xcursor (GdkCursor *cursor)

4
gdk/x11/gdkmain-x11.c
View File

@ -439,7 +439,7 @@ gdk_x11_get_default_screen (void)
* Gets the root window of the default screen
* (see gdk_x11_get_default_screen()).
*
* Return value: an Xlib <type>Window</type>.
* Return value: an Xlib Window.
**/
Window
gdk_x11_get_default_root_xwindow (void)
@ -452,7 +452,7 @@ gdk_x11_get_default_root_xwindow (void)
*
* Gets the default GTK+ display.
*
* Return value: (transfer none): the Xlib <type>Display*</type> for
* Return value: (transfer none): the Xlib Display* for
* the display specified in the <option>--display</option> command
* line option or the <envar>DISPLAY</envar> environment variable.
**/

2
gdk/x11/gdkscreen-x11.c
View File

@ -424,7 +424,7 @@ gdk_x11_screen_get_rgba_visual (GdkScreen *screen)
*
* Returns the screen of a #GdkScreen.
*
* Returns: (transfer none): an Xlib <type>Screen*</type>
* Returns: (transfer none): an Xlib Screen*
*
* Since: 2.2
*/

2
gdk/x11/gdkvisual-x11.c
View File

@ -591,7 +591,7 @@ _gdk_visual_get_x11_colormap (GdkVisual *visual)
*
* Returns the X visual belonging to a #GdkVisual.
*
* Return value: (transfer none): an Xlib <type>Visual*</type>.
* Return value: (transfer none): an Xlib Visual*.
**/
Visual *
gdk_x11_visual_get_xvisual (GdkVisual *visual)

2
gdk/x11/gdkwindow-x11.c
View File

@ -1173,7 +1173,7 @@ x_event_mask_to_gdk_event_mask (long mask)
/**
* gdk_x11_window_foreign_new_for_display:
* @display: (type GdkX11Display): the #GdkDisplay where the window handle comes from.
* @window: an XLib <type>Window</type>
* @window: an Xlib Window
*
* Wraps a native window in a #GdkWindow. The function will try to
* look up the window using gdk_x11_window_lookup_for_display() first.

4
gdk/x11/gdkx11cursor.h
View File

@ -64,7 +64,7 @@ Cursor gdk_x11_cursor_get_xcursor (GdkCursor *cursor);
*
* Returns the display of a #GdkCursor.
*
* Returns: an Xlib <type>Display*</type>.
* Returns: an Xlib Display*.
*/
#define GDK_CURSOR_XDISPLAY(cursor) (gdk_x11_cursor_get_xdisplay (cursor))
@ -74,7 +74,7 @@ Cursor gdk_x11_cursor_get_xcursor (GdkCursor *cursor);
*
* Returns the X cursor belonging to a #GdkCursor.
*
* Returns: an Xlib <type>Cursor</type>.
* Returns: an Xlib Cursor.
*/
#define GDK_CURSOR_XCURSOR(cursor) (gdk_x11_cursor_get_xcursor (cursor))

4
gdk/x11/gdkx11screen.h
View File

@ -72,7 +72,7 @@ gint gdk_x11_get_default_screen (void);
*
* Returns the display of a X11 #GdkScreen.
*
* Returns: an Xlib <type>Display*</type>
* Returns: an Xlib Display*.
*/
#define GDK_SCREEN_XDISPLAY(screen) (gdk_x11_display_get_xdisplay (gdk_screen_get_display (screen)))
@ -82,7 +82,7 @@ gint gdk_x11_get_default_screen (void);
*
* Returns the screen of a X11 #GdkScreen.
*
* Returns: an Xlib <type>Screen*</type>
* Returns: an Xlib Screen*
*/
#define GDK_SCREEN_XSCREEN(screen) (gdk_x11_screen_get_xscreen (screen))

4
gdk/x11/gdkx11window.h
View File

@ -93,7 +93,7 @@ void gdk_x11_window_set_frame_sync_enabled (GdkWindow *window,
*
* Returns the display of a #GdkWindow.
*
* Returns: an Xlib <type>Display*</type>.
* Returns: an Xlib Display*.
*/
#define GDK_WINDOW_XDISPLAY(win) (GDK_DISPLAY_XDISPLAY (gdk_window_get_display (win)))
@ -103,7 +103,7 @@ void gdk_x11_window_set_frame_sync_enabled (GdkWindow *window,
*
* Returns the X window belonging to a #GdkWindow.
*
* Returns: the Xlib <type>Window</type> of @win.
* Returns: the Xlib Window of @win.
*/
#define GDK_WINDOW_XID(win) (gdk_x11_window_get_xid (win))

2
gdk/x11/gdkxid.c
View File

@ -81,7 +81,7 @@ _gdk_x11_display_remove_window (GdkDisplay *display,
* gdk_x11_window_lookup_for_display:
* @display: (type GdkX11Display): the #GdkDisplay corresponding to the
* window handle
* @window: an XLib <type>Window</type>
* @window: an Xlib Window
*
* Looks up the #GdkWindow that wraps the given native window handle.
*

2
gtk/deprecated/gtkstyle.c
View File

@ -1172,7 +1172,7 @@ gtk_style_get_style_property (GtkStyle *style,
* @style: a #GtkStyle
* @widget_type: the #GType of a descendant of #GtkWidget
* @first_property_name: the name of the first style property to get
* @var_args: a <type>va_list</type> of pairs of property names and
* @var_args: a va_list of pairs of property names and
* locations to return the property values, starting with the
* location for @first_property_name.
*

2
gtk/gtkappchooser.c
View File

@ -66,7 +66,7 @@ gtk_app_chooser_default_init (GtkAppChooserIface *iface)
*
* The content type of the #GtkAppChooser object.
*
* See <link linkend="gio-GContentType"><type>GContentType</type></link>
* See <link linkend="gio-GContentType">GContentType</link>
* for more information about content types.
*/
pspec = g_param_spec_string ("content-type",

6
gtk/gtktreemodel.c
View File

@ -1733,7 +1733,7 @@ gtk_tree_model_unref_node (GtkTreeModel *tree_model,
* retrieved. The list is terminated by a -1. For example, to get a
* value from column 0 with type %G_TYPE_STRING, you would
* write: <literal>gtk_tree_model_get (model, iter, 0, &amp;place_string_here, -1)</literal>,
* where <literal>place_string_here</literal> is a <type>gchar*</type>
* where <literal>place_string_here</literal> is a #gchararray
* to be filled with the string.
*
* Returned values with type %G_TYPE_OBJECT have to be unreferenced,
@ -1759,9 +1759,9 @@ gtk_tree_model_get (GtkTreeModel *tree_model,
* gtk_tree_model_get_valist:
* @tree_model: a #GtkTreeModel
* @iter: a row in @tree_model
* @var_args: <type>va_list</type> of column/return location pairs
* @var_args: va_list of column/return location pairs
*
* See gtk_tree_model_get(), this version takes a <type>va_list</type>
* See gtk_tree_model_get(), this version takes a va_list
* for language bindings to use.
*/
void

6
gtk/gtktreestore.c
View File

@ -308,7 +308,7 @@ gtk_tree_store_init (GtkTreeStore *tree_store)
*
* As an example, <literal>gtk_tree_store_new (3, G_TYPE_INT, G_TYPE_STRING,
* GDK_TYPE_PIXBUF);</literal> will create a new #GtkTreeStore with three columns, of type
* <type>int</type>, <type>string</type> and #GdkPixbuf respectively.
* #gint, #gchararray, and #GdkPixbuf respectively.
*
* Return value: a new #GtkTreeStore
**/
@ -1125,9 +1125,9 @@ gtk_tree_store_set_valuesv (GtkTreeStore *tree_store,
* gtk_tree_store_set_valist:
* @tree_store: A #GtkTreeStore
* @iter: A valid #GtkTreeIter for the row being modified
* @var_args: <type>va_list</type> of column/value pairs
* @var_args: va_list of column/value pairs
*
* See gtk_tree_store_set(); this version takes a <type>va_list</type> for
* See gtk_tree_store_set(); this version takes a va_list for
* use by language bindings.
*
**/

2
gtk/gtkwidget.c
View File

@ -12533,7 +12533,7 @@ gtk_widget_style_get_property (GtkWidget *widget,
* gtk_widget_style_get_valist:
* @widget: a #GtkWidget
* @first_property_name: the name of the first property to get
* @var_args: a <type>va_list</type> of pairs of property names and
* @var_args: a va_list of pairs of property names and
* locations to return the property values, starting with the location
* for @first_property_name.
*