Fix docstring (#2253)

Author: lenemter

src/Widgets/IconGroup.vala

@@ -17,15 +17,15 @@ public class Gala.IconGroup : CanvasActor {
     private const int BACKDROP_ABSOLUTE_OPACITY = 40;
 
     /**
-        * The group has been clicked. The MultitaskingView should consider activating
-        * its workspace.
-        */
+     * The group has been clicked. The MultitaskingView should consider activating
+     * its workspace.
+     */
     public signal void selected ();
 
     private float _backdrop_opacity = 0.0f;
     /**
-        * The opacity of the backdrop/highlight.
-        */
+     * The opacity of the backdrop/highlight.
+     */
     public float backdrop_opacity {
         get {
             return _backdrop_opacity;
@@ -99,8 +99,8 @@ public class Gala.IconGroup : CanvasActor {
     }
 
     /**
-        * Override the paint handler to draw our backdrop if necessary
-        */
+     * Override the paint handler to draw our backdrop if necessary
+     */
     public override void paint (Clutter.PaintContext context) {
         if (backdrop_opacity == 0.0 || drag_action.dragging) {
             base.paint (context);
@@ -130,21 +130,21 @@ public class Gala.IconGroup : CanvasActor {
     }
 
     /**
-        * Remove all currently added WindowIconActors
-        */
+     * Remove all currently added WindowIconActors
+     */
     public void clear () {
         icon_container.destroy_all_children ();
     }
 
     /**
-        * Creates a WindowIconActor for the given window and adds it to the group
-        *
-        * @param window    The MetaWindow for which to create the WindowIconActor
-        * @param no_redraw If you add multiple windows at once you may want to consider
-        *                  settings this to true and when done calling redraw() manually
-        * @param temporary Mark the WindowIconActor as temporary. Used for windows dragged over
-        *                  the group.
-        */
+     * Creates a WindowIconActor for the given window and adds it to the group
+     *
+     * @param window    The MetaWindow for which to create the WindowIconActor
+     * @param no_redraw If you add multiple windows at once you may want to consider
+     *                  settings this to true and when done calling redraw() manually
+     * @param temporary Mark the WindowIconActor as temporary. Used for windows dragged over
+     *                  the group.
+     */
     public void add_window (Meta.Window window, bool no_redraw = false, bool temporary = false) {
         var new_window = new WindowIconActor (window);
         new_window.set_position (32, 32);
@@ -157,10 +157,10 @@ public class Gala.IconGroup : CanvasActor {
     }
 
     /**
-        * Remove the WindowIconActor for a MetaWindow from the group
-        *
-        * @param animate Whether to fade the icon out before removing it
-        */
+     * Remove the WindowIconActor for a MetaWindow from the group
+     *
+     * @param animate Whether to fade the icon out before removing it
+     */
     public void remove_window (Meta.Window window, bool animate = true) {
         foreach (unowned var child in icon_container.get_children ()) {
             unowned var icon = (WindowIconActor) child;
@@ -192,23 +192,23 @@ public class Gala.IconGroup : CanvasActor {
     }
 
     /**
-        * Sets a hovered actor for the drag action.
-        */
+     * Sets a hovered actor for the drag action.
+     */
     public void set_hovered_actor (Clutter.Actor actor) {
         drag_action.hovered = actor;
     }
 
     /**
-        * Trigger a redraw
-        */
+     * Trigger a redraw
+     */
     public void redraw () {
         content.invalidate ();
     }
 
     /**
-        * Draw the background or plus sign and do layouting. We won't lose performance here
-        * by relayouting in the same function, as it's only ever called when we invalidate it.
-        */
+     * Draw the background or plus sign and do layouting. We won't lose performance here
+     * by relayouting in the same function, as it's only ever called when we invalidate it.
+     */
     protected override void draw (Cairo.Context cr, int cr_width, int cr_height) {
         clear_effects ();
         cr.set_operator (Cairo.Operator.CLEAR);

src/Widgets/IconGroupContainer.vala

@@ -66,28 +66,28 @@ public class Gala.IconGroupContainer : Clutter.Actor {
     }
 
     /**
-        * Removes an icon group "in place".
-        * When initially dragging an icon group we remove
-        * it and it's previous WorkspaceInsertThumb. This would make
-        * the container immediately reallocate and fill the empty space
-        * with right-most IconGroups.
-        *
-        * We don't want that until the IconGroup
-        * leaves the expanded WorkspaceInsertThumb.
-        */
+     * Removes an icon group "in place".
+     * When initially dragging an icon group we remove
+     * it and it's previous WorkspaceInsertThumb. This would make
+     * the container immediately reallocate and fill the empty space
+     * with right-most IconGroups.
+     *
+     * We don't want that until the IconGroup
+     * leaves the expanded WorkspaceInsertThumb.
+     */
     public void remove_group_in_place (IconGroup group) {
         var deleted_thumb = (WorkspaceInsertThumb) group.get_previous_sibling ();
         var deleted_placeholder_thumb = (WorkspaceInsertThumb) group.get_next_sibling ();
 
         remove_group (group);
 
-        /**
-            * We will account for that empty space
-            * by manually expanding the next WorkspaceInsertThumb with the
-            * width we deleted. Because the IconGroup is still hovering over
-            * the expanded thumb, we will also update the drag & drop action
-            * of IconGroup on that.
-            */
+        /*
+        * We will account for that empty space
+        * by manually expanding the next WorkspaceInsertThumb with the
+        * width we deleted. Because the IconGroup is still hovering over
+        * the expanded thumb, we will also update the drag & drop action
+        * of IconGroup on that.
+        */
         if (deleted_placeholder_thumb != null) {
             float deleted_width = deleted_thumb.get_width () + group.get_width ();
             deleted_placeholder_thumb.expanded = true;
@@ -111,9 +111,9 @@ public class Gala.IconGroupContainer : Clutter.Actor {
     }
 
     /**
-        * Calculates the width that will be occupied taking currently running animations
-        * end states into account
-        */
+     * Calculates the width that will be occupied taking currently running animations
+     * end states into account
+     */
     public float calculate_total_width () {
         var spacing = InternalUtils.scale_to_int (SPACING, scale_factor);
         var group_width = InternalUtils.scale_to_int (GROUP_WIDTH, scale_factor);

src/WorkspaceManager.vala

@@ -214,10 +214,10 @@ public class Gala.WorkspaceManager : Object {
     }
 
     /**
-        * Make sure we switch to a different workspace and remove the given one
-        *
-        * @param workspace The workspace to remove
-        */
+     * Make sure we switch to a different workspace and remove the given one
+     *
+     * @param workspace The workspace to remove
+     */
     private void remove_workspace (Meta.Workspace workspace) {
         unowned Meta.Display display = workspace.get_display ();
         unowned Meta.WorkspaceManager manager = display.get_workspace_manager ();
@@ -252,15 +252,15 @@ public class Gala.WorkspaceManager : Object {
     }
 
     /**
-        * Temporarily disables removing workspaces when they are empty
-        */
+     * Temporarily disables removing workspaces when they are empty
+     */
     public void freeze_remove () {
         GLib.AtomicInt.inc (ref remove_freeze_count);
     }
 
     /**
-        * Undo the effect of freeze_remove()
-        */
+     * Undo the effect of freeze_remove()
+     */
     public void thaw_remove () {
         if (GLib.AtomicInt.dec_and_test (ref remove_freeze_count)) {
             cleanup ();
@@ -270,10 +270,10 @@ public class Gala.WorkspaceManager : Object {
     }
 
     /**
-        * If workspaces are dynamic, checks if there are empty workspaces that should
-        * be removed. Particularly useful in conjunction with freeze/thaw_remove to
-        * cleanup after an operation that required stable workspace/window indices
-        */
+     * If workspaces are dynamic, checks if there are empty workspaces that should
+     * be removed. Particularly useful in conjunction with freeze/thaw_remove to
+     * cleanup after an operation that required stable workspace/window indices
+     */
     private void cleanup () {
         if (!Meta.Prefs.get_dynamic_workspaces ()) {
             return;