summaryrefslogtreecommitdiff
path: root/src/core/display.c
diff options
context:
space:
mode:
Diffstat (limited to 'src/core/display.c')
-rw-r--r--src/core/display.c47
1 files changed, 31 insertions, 16 deletions
diff --git a/src/core/display.c b/src/core/display.c
index 34d2963..30638aa 100644
--- a/src/core/display.c
+++ b/src/core/display.c
@@ -1,4 +1,4 @@
-/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
+* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
/* Metacity X display handler */
@@ -25,7 +25,8 @@
*/
-/*! \file display.c
+/**
+ * \file display.c
*
* \brief Handles operations on an X display.
*
@@ -94,7 +95,8 @@
g == META_GRAB_OP_KEYBOARD_ESCAPING_DOCK || \
g == META_GRAB_OP_KEYBOARD_ESCAPING_GROUP)
-/*! \defgroup pings Pings
+/**
+ * \defgroup pings Pings
*
* Sometimes we want to see whether a window is responding,
* so we send it a "ping" message and see whether it sends us back a "pong"
@@ -108,7 +110,8 @@
* that we're never going to do so and simplify it a bit.
*/
-/*! Describes a ping on a window. When we send a ping to a window, we build
+/**
+ * Describes a ping on a window. When we send a ping to a window, we build
* one of these structs, and it eventually gets passed to the timeout function
* or to the function which handles the response from the window. If the window
* does or doesn't respond to the ping, we use this information to deal with
@@ -163,7 +166,8 @@ static void sanity_check_timestamps (MetaDisplay *display,
MetaGroup* get_focussed_group (MetaDisplay *display);
-/*! Destructor for MetaPingData structs. Will destroy the
+/**
+ * Destructor for MetaPingData structs. Will destroy the
* event source for the struct as well.
*
* \ingroup pings
@@ -178,7 +182,8 @@ ping_data_free (MetaPingData *ping_data)
g_free (ping_data);
}
-/*! Frees every pending ping structure for the given X window on the
+/**
+ * Frees every pending ping structure for the given X window on the
* given display. This means that we also destroy the timeouts.
*
* \param display The display the window appears on
@@ -296,7 +301,8 @@ disable_compositor (MetaDisplay *display)
display->compositor = NULL;
}
-/*! Opens a new display, sets it up, initialises all the X extensions
+/**
+ * Opens a new display, sets it up, initialises all the X extensions
* we will need, and adds it to the list of displays.
*
* \return True if the display was opened successfully, and False
@@ -1559,7 +1565,8 @@ handle_net_restack_window (MetaDisplay* display,
}
#endif
-/*! This is the most important function in the whole program. It is the heart,
+/**
+ * This is the most important function in the whole program. It is the heart,
* it is the nexus, it is the Grand Central Station of Metacity's world.
* When we create a MetaDisplay, we ask GDK to pass *all* events for *all*
* windows to this function. So every time anything happens that we might
@@ -4130,11 +4137,13 @@ meta_display_set_cursor_theme (const char *theme,
#endif
}
-/*! Stores whether syncing is currently enabled.
+/**
+ * Stores whether syncing is currently enabled.
*/
static gboolean is_syncing = FALSE;
-/*! Returns whether X synchronisation is currently enabled.
+/**
+ * Returns whether X synchronisation is currently enabled.
*
* \return true if we must wait for events whenever we send X requests;
* false otherwise.
@@ -4150,7 +4159,8 @@ meta_is_syncing (void)
return is_syncing;
}
-/*! A handy way to turn on synchronisation on or off for every display.
+/**
+ * A handy way to turn on synchronisation on or off for every display.
*
* \bug Of course there is only one display ever anyway, so this can
* be rather hugely simplified.
@@ -4174,12 +4184,14 @@ meta_set_syncing (gboolean setting)
}
}
-/*! How long, in milliseconds, we should wait after pinging a window
+/**
+ * How long, in milliseconds, we should wait after pinging a window
* before deciding it's not going to get back to us.
*/
#define PING_TIMEOUT_DELAY 2250
-/*! Does whatever it is we decided to do when a window didn't respond
+/**
+ * Does whatever it is we decided to do when a window didn't respond
* to a ping. We also remove the ping from the display's list of
* pending pings. This function is called by the event loop when the timeout
* times out which we created at the start of the ping.
@@ -4217,7 +4229,8 @@ meta_display_ping_timeout (gpointer data)
return FALSE;
}
-/*! Sends a ping request to a window. The window must respond to
+/**
+ * Sends a ping request to a window. The window must respond to
* the request within a certain amount of time. If it does, we
* will call one callback; if the time passes and we haven't had
* a response, we call a different callback. The window must have
@@ -4354,7 +4367,8 @@ process_request_frame_extents (MetaDisplay *display,
meta_XFree (hints);
}
-/*! Process the pong (the response message) from the ping we sent
+/**
+ * Process the pong (the response message) from the ping we sent
* to the window. This involves removing the timeout, calling the
* reply handler function, and freeing memory.
*
@@ -4409,7 +4423,8 @@ process_pong_message (MetaDisplay *display,
}
}
-/*! Finds whether a window has any pings waiting on it.
+/**
+ * Finds whether a window has any pings waiting on it.
*
* \param display The MetaDisplay of the window.
* \param window The MetaWindow whose pings we want to know about.