finch/libgnt/gntws.h

branch
gtkdoc-conversion
changeset 35393
00f876b129bc
parent 31293
169eeb43b52c
child 35409
2c495383415e
child 37035
e85ed7f4d6e3
--- a/finch/libgnt/gntws.h	Fri Jan 31 17:56:27 2014 +0530
+++ b/finch/libgnt/gntws.h	Fri Jan 31 18:14:33 2014 +0530
@@ -70,7 +70,7 @@
 G_BEGIN_DECLS
 
 /**
- * @return The GType for GntWS.
+ * Returns: The GType for GntWS.
  *
  * @since 2.0.0 (gnt), 2.1.0 (pidgin)
  */
@@ -79,9 +79,9 @@
 /**
  * Create a new workspace with the specified name.
  *
- * @param name  The desired name of the workspace, or @c NULL.
+ * @name:  The desired name of the workspace, or %NULL.
  *
- * @return The newly created workspace.
+ * Returns: The newly created workspace.
  *
  * @since 2.0.0 (gnt), 2.1.0 (pidgin)
  */
@@ -90,8 +90,8 @@
 /**
  * Set the name of a workspace.
  *
- * @param ws    The workspace to rename.
- * @param name  The new name of the workspace.
+ * @ws:    The workspace to rename.
+ * @name:  The new name of the workspace.
  *
  * @since 2.0.0 (gnt), 2.1.0 (pidgin)
  */
@@ -100,8 +100,8 @@
 /**
  * Add a widget to a workspace.
  *
- * @param ws     The workspace.
- * @param widget The widget to add.
+ * @ws:     The workspace.
+ * @widget: The widget to add.
  *
  * @since 2.0.0 (gnt), 2.1.0 (pidgin)
  */
@@ -110,8 +110,8 @@
 /**
  * Remove a widget from a workspace.
  *
- * @param ws      The workspace
- * @param widget  The widget to remove from the workspace.
+ * @ws:      The workspace
+ * @widget:  The widget to remove from the workspace.
  *
  * @since 2.0.0 (gnt), 2.1.0 (pidgin)
  */
@@ -120,8 +120,8 @@
 /**
  * Hide a widget in a workspace.
  *
- * @param widget  The widget to hide.
- * @param nodes   A hashtable containing information about the widgets.
+ * @widget:  The widget to hide.
+ * @nodes:   A hashtable containing information about the widgets.
  *
  * @since 2.0.0 (gnt), 2.1.0 (pidgin)
  */
@@ -130,8 +130,8 @@
 /**
  * Show a widget in a workspace.
  *
- * @param widget   The widget to show.
- * @param nodes   A hashtable containing information about the widgets.
+ * @widget:   The widget to show.
+ * @nodes:   A hashtable containing information about the widgets.
  *
  * @since 2.0.0 (gnt), 2.1.0 (pidgin)
  */
@@ -140,8 +140,8 @@
 /**
  * Draw the taskbar in a workspace.
  *
- * @param ws         The workspace.
- * @param reposition Whether the workspace should reposition the taskbar.
+ * @ws:         The workspace.
+ * @reposition: Whether the workspace should reposition the taskbar.
  *
  * @since 2.0.0 (gnt), 2.1.0 (pidgin)
  */
@@ -150,8 +150,8 @@
 /**
  * Hide a workspace.
  *
- * @param ws      The workspace to hide.
- * @param table   A hashtable containing information about the widgets.
+ * @ws:      The workspace to hide.
+ * @table:   A hashtable containing information about the widgets.
  *
  * @since 2.0.0 (gnt), 2.1.0 (pidgin)
  */
@@ -160,8 +160,8 @@
 /**
  * Show a workspace.
  *
- * @param ws      The workspace to hide.
- * @param table   A hashtable containing information about the widgets.
+ * @ws:      The workspace to hide.
+ * @table:   A hashtable containing information about the widgets.
  *
  * @since 2.0.0 (gnt), 2.1.0 (pidgin)
  */
@@ -170,8 +170,8 @@
 /**
  * Get the name of a workspace.
  *
- * @param ws   The workspace.
- * @return  The name of the workspace (can be @c NULL).
+ * @ws:   The workspace.
+ * Returns:  The name of the workspace (can be %NULL).
  *
  * @since 2.0.0 (gnt), 2.1.0 (pidgin)
  */

mercurial