diff --git a/ChangeLog b/ChangeLog index a4d0d7734..b97baeda0 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,10 @@ 2008-06-30 Thomas Thurman + * src/core/bell.[ch]: Move comments for non-statics from the .c to .h. + * Doxyfile: adapt better for C, and make quiet. + +2008-06-29 Thomas Thurman + * src/ui/theme-viewer.c (main): display the theme name in the title bar. Closes #430198. diff --git a/Doxyfile b/Doxyfile index d2509b313..a8a75411a 100644 --- a/Doxyfile +++ b/Doxyfile @@ -195,7 +195,7 @@ ALIASES = # For instance, some of the names that are used will be different. The list # of all members will be omitted, etc. -OPTIMIZE_OUTPUT_FOR_C = NO +OPTIMIZE_OUTPUT_FOR_C = YES # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java # sources only. Doxygen will then generate output that is more tailored for Java. @@ -427,7 +427,7 @@ FILE_VERSION_FILTER = # The QUIET tag can be used to turn on/off the messages that are generated # by doxygen. Possible values are YES and NO. If left blank NO is used. -QUIET = NO +QUIET = YES # The WARNINGS tag can be used to turn on/off the warning messages that are # generated by doxygen. Possible values are YES and NO. If left blank diff --git a/src/core/bell.c b/src/core/bell.c index 578a36b40..a3baee6ab 100644 --- a/src/core/bell.c +++ b/src/core/bell.c @@ -273,16 +273,6 @@ bell_visual_notify (MetaDisplay *display, } } -/** - * Gives the user some kind of visual bell; in fact, this is our response - * to any kind of bell request, but we set it up so that we only get - * notified about visual bells, and X deals with audible ones. - * - * If the configure script found we had no XKB, this does not exist. - * - * \param display The display the bell event came in on - * \param xkb_ev The bell event we just received - */ void meta_bell_notify (MetaDisplay *display, XkbAnyEvent *xkb_ev) @@ -293,16 +283,7 @@ meta_bell_notify (MetaDisplay *display, } #endif /* HAVE_XKB */ -/** - * Turns the bell to audible or visual. This tells X what to do, but - * not Metacity; you will need to set the "visual bell" pref for that. - * - * If the configure script found we had no XKB, this is a no-op. - * - * \param display The display we're configuring - * \param audible True for an audible bell, false for a visual bell - */ -void +metavoid meta_bell_set_audible (MetaDisplay *display, gboolean audible) { #ifdef HAVE_XKB @@ -313,27 +294,6 @@ meta_bell_set_audible (MetaDisplay *display, gboolean audible) #endif } -/** - * Initialises the bell subsystem. This involves intialising - * XKB (which, despite being a keyboard extension, is the - * place to look for bell notifications), then asking it - * to send us bell notifications, and then also switching - * off the audible bell if we're using a visual one ourselves. - * - * Unlike most X extensions we use, we only initialise XKB here - * (rather than in main()). It's possible that XKB is not - * installed at all, but if that was known at build time - * we will have HAVE_XKB undefined, which will cause this - * function to be a no-op. - * - * \param display The display which is opening - * - * \bug There is a line of code that's never run that tells - * XKB to reset the bell status after we quit. Bill H said - * () - * that XFree86's implementation is broken so we shouldn't - * call it, but that was in 2002. Is it working now? - */ gboolean meta_bell_init (MetaDisplay *display) { @@ -375,15 +335,6 @@ meta_bell_init (MetaDisplay *display) return FALSE; } -/** - * Shuts down the bell subsystem. - * - * \param display The display which is closing - * - * \bug This is never called! If we had XkbSetAutoResetControls - * enabled in meta_bell_init(), this wouldn't be a problem, but - * we don't. - */ void meta_bell_shutdown (MetaDisplay *display) { @@ -396,14 +347,6 @@ meta_bell_shutdown (MetaDisplay *display) #endif } -/** - * Deals with a frame being destroyed. This is important because if we're - * using a visual bell, we might be flashing the edges of the frame, and - * so we'd have a timeout function waiting ready to un-flash them. If the - * frame's going away, we can tell the timeout not to bother. - * - * \param frame The frame which is being destroyed - */ void meta_bell_notify_frame_destroy (MetaFrame *frame) { diff --git a/src/core/bell.h b/src/core/bell.h index d33c8d212..462d1ed73 100644 --- a/src/core/bell.h +++ b/src/core/bell.h @@ -1,6 +1,17 @@ -/* Metacity visual bell */ - /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */ + +/** + * \file bell.h Ring the bell or flash the screen + * + * Sometimes, X programs "ring the bell", whatever that means. Metacity lets + * the user configure the bell to be audible or visible (aka visual), and + * if it's visual it can be configured to be frame-flash or fullscreen-flash. + * We never get told about audible bells; X handles them just fine by itself. + * + * The visual bell was the result of a discussion in Bugzilla here: + * . + */ + /* * Copyright (C) 2002 Sun Microsystems Inc. * @@ -28,9 +39,70 @@ #include "frame-private.h" #ifdef HAVE_XKB +/** + * Gives the user some kind of visual bell; in fact, this is our response + * to any kind of bell request, but we set it up so that we only get + * notified about visual bells, and X deals with audible ones. + * + * If the configure script found we had no XKB, this does not exist. + * + * \param display The display the bell event came in on + * \param xkb_ev The bell event we just received + */ void meta_bell_notify (MetaDisplay *display, XkbAnyEvent *xkb_ev); #endif + +/** + * Turns the bell to audible or visual. This tells X what to do, but + * not Metacity; you will need to set the "visual bell" pref for that. + * + * If the configure script found we had no XKB, this is a no-op. + * + * \param display The display we're configuring + * \param audible True for an audible bell, false for a visual bell + */ void meta_bell_set_audible (MetaDisplay *display, gboolean audible); + +/** + * Initialises the bell subsystem. This involves intialising + * XKB (which, despite being a keyboard extension, is the + * place to look for bell notifications), then asking it + * to send us bell notifications, and then also switching + * off the audible bell if we're using a visual one ourselves. + * + * Unlike most X extensions we use, we only initialise XKB here + * (rather than in main()). It's possible that XKB is not + * installed at all, but if that was known at build time + * we will have HAVE_XKB undefined, which will cause this + * function to be a no-op. + * + * \param display The display which is opening + * + * \bug There is a line of code that's never run that tells + * XKB to reset the bell status after we quit. Bill H said + * () + * that XFree86's implementation is broken so we shouldn't + * call it, but that was in 2002. Is it working now? + */ gboolean meta_bell_init (MetaDisplay *display); + +/** + * Shuts down the bell subsystem. + * + * \param display The display which is closing + * + * \bug This is never called! If we had XkbSetAutoResetControls + * enabled in meta_bell_init(), this wouldn't be a problem, but + * we don't. + */ void meta_bell_shutdown (MetaDisplay *display); + +/** + * Deals with a frame being destroyed. This is important because if we're + * using a visual bell, we might be flashing the edges of the frame, and + * so we'd have a timeout function waiting ready to un-flash them. If the + * frame's going away, we can tell the timeout not to bother. + * + * \param frame The frame which is being destroyed + */ void meta_bell_notify_frame_destroy (MetaFrame *frame);