2006-09-12 Michael Dominic Kostrzewa <michael.kostrzewa@nokia.com>

[hildon] / hildon-widgets / hildon-vvolumebar.c

diff --git a/hildon-widgets/hildon-vvolumebar.c b/hildon-widgets/hildon-vvolumebar.c
index 35491d1..1069f9b 100644 (file)
--- a/hildon-widgets/hildon-vvolumebar.c
+++ b/hildon-widgets/hildon-vvolumebar.c
@@ -1,14 +1,14 @@
 /*
  * This file is part of hildon-libs
  *
- * Copyright (C) 2005 Nokia Corporation.
+ * Copyright (C) 2005, 2006 Nokia Corporation, all rights reserved.
  *
- * Contact: Luc Pionchon <luc.pionchon@nokia.com>
+ * Contact: Michael Dominic Kostrzewa <michael.kostrzewa@nokia.com>
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public License
- * as published by the Free Software Foundation; either version 2.1 of
- * the License, or (at your option) any later version.
+ * as published by the Free Software Foundation; version 2.1 of
+ * the License or any later version.
  *
  * This library is distributed in the hope that it will be useful, but
  * WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -23,11 +23,13 @@
  */
 
 /*
- * @file hildon-vvolumebar.c
+ * SECTION:hildon-vvolumebar
+ * @short_description: A widget that displays a vertical volume bar
+ * @see_also: #HildonVolumebar, #HildonHVolumebar
  *
- * This file contains the implementation of HildonVVolumebar.
- * This widget is a subclass of HildonVolumebar and implements
- * horizontal version of Volumebar.
+ * #HildonVVolumebar is a subclass of #HildonVolumebar.  It displays a
+ * vertical volume bar that allows increasing or decreasing volume
+ * within a predefined range, and muting when users click the mute icon.
  */
 
 #ifdef HAVE_CONFIG_H
@@ -126,7 +128,7 @@ static void hildon_vvolumebar_init(HildonVVolumebar * vvolumebar)
  *
  * Creates a new #HildonVVolumebar widget.
  *
- * Returns: a new #HildonVVolumebar.
+ * Returns: a new #HildonVVolumebar
  */
 GtkWidget *hildon_vvolumebar_new(void)
 {