From: Orestis Floros <orestisf1993@gmail.com>
Date: Sat, 21 Apr 2018 10:02:14 +0000 (+0300)
Subject: Make comment style more consistent
X-Git-Tag: 4.16~14^2~7
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=e4d2b385529847b926a716731be4a8c22ed79007;p=i3%2Fi3

Make comment style more consistent
---

diff --git a/include/commands.h b/include/commands.h
index b4b3da38..0137460f 100644
--- a/include/commands.h
+++ b/include/commands.h
@@ -314,13 +314,13 @@ void cmd_rename_workspace(I3_CMD, const char *old_name, const char *new_name);
  */
 void cmd_bar(I3_CMD, const char *bar_type, const char *bar_value, const char *bar_id);
 
-/*
+/**
  * Implementation of 'shmlog <size>|toggle|on|off'
  *
  */
 void cmd_shmlog(I3_CMD, const char *argument);
 
-/*
+/**
  * Implementation of 'debuglog toggle|on|off'
  *
  */
diff --git a/include/commands_parser.h b/include/commands_parser.h
index 88b3f6d0..b65ae93f 100644
--- a/include/commands_parser.h
+++ b/include/commands_parser.h
@@ -13,7 +13,7 @@
 
 #include <yajl/yajl_gen.h>
 
-/*
+/**
  * Holds an intermediate represenation of the result of a call to any command.
  * When calling parse_command("floating enable, border none"), the parser will
  * internally use this struct when calling cmd_floating and cmd_border.
diff --git a/include/con.h b/include/con.h
index 672d80ac..2c991b0c 100644
--- a/include/con.h
+++ b/include/con.h
@@ -20,7 +20,8 @@
  */
 Con *con_new_skeleton(Con *parent, i3Window *window);
 
-/* A wrapper for con_new_skeleton, to retain the old con_new behaviour
+/**
+ * A wrapper for con_new_skeleton, to retain the old con_new behaviour
  *
  */
 Con *con_new(Con *parent, i3Window *window);
@@ -220,7 +221,7 @@ void con_mark_toggle(Con *con, const char *mark, mark_mode_t mode);
  */
 void con_mark(Con *con, const char *mark, mark_mode_t mode);
 
-/*
+/**
  * Removes marks from containers.
  * If con is NULL, all containers are considered.
  * If name is NULL, this removes all existing marks.
@@ -402,7 +403,7 @@ Con *con_descend_focused(Con *con);
  */
 Con *con_descend_tiling_focused(Con *con);
 
-/*
+/**
  * Returns the leftmost, rightmost, etc. container in sub-tree. For example, if
  * direction is D_LEFT, then we return the rightmost container and if direction
  * is D_RIGHT, we return the leftmost container.  This is because if we are
diff --git a/include/config_parser.h b/include/config_parser.h
index ace4041d..009538f2 100644
--- a/include/config_parser.h
+++ b/include/config_parser.h
@@ -16,7 +16,7 @@
 SLIST_HEAD(variables_head, Variable);
 extern pid_t config_error_nagbar_pid;
 
-/*
+/**
  * An intermediate reprsentation of the result of a parse_config call.
  * Currently unused, but the JSON output will be useful in the future when we
  * implement a config parsing IPC command.
diff --git a/include/libi3.h b/include/libi3.h
index bcd2b7b1..790baba9 100644
--- a/include/libi3.h
+++ b/include/libi3.h
@@ -343,7 +343,7 @@ uint32_t get_colorpixel(const char *hex) __attribute__((const));
 
 #if defined(__APPLE__)
 
-/*
+/**
  * Taken from FreeBSD
  * Returns a pointer to a new string which is a duplicate of the
  * string, but only copies at most n characters.
diff --git a/include/match.h b/include/match.h
index 4ff8c485..043c3a8f 100644
--- a/include/match.h
+++ b/include/match.h
@@ -15,7 +15,7 @@
 
 #include <config.h>
 
-/*
+/**
  * Initializes the Match data structure. This function is necessary because the
  * members representing boolean values (like dock) need to be initialized with
  * -1 instead of 0.
diff --git a/include/randr.h b/include/randr.h
index 39182c54..ec533a28 100644
--- a/include/randr.h
+++ b/include/randr.h
@@ -137,7 +137,7 @@ Output *get_output_next(direction_t direction, Output *current, output_close_far
  */
 Output *get_output_next_wrap(direction_t direction, Output *current);
 
-/*
+/**
  * Creates an output covering the root window.
  *
  */
diff --git a/include/render.h b/include/render.h
index 750b7d31..2b2c8dad 100644
--- a/include/render.h
+++ b/include/render.h
@@ -12,7 +12,10 @@
 
 #include <config.h>
 
-/* This is used to keep a state to pass around when rendering a con in render_con(). */
+/**
+ * This is used to keep a state to pass around when rendering a con in render_con().
+ *
+ */
 typedef struct render_params {
     /* A copy of the coordinates of the container which is being rendered. */
     int x;
@@ -39,7 +42,8 @@ typedef struct render_params {
  */
 void render_con(Con *con, bool render_fullscreen);
 
-/*
+/**
  * Returns the height for the decorations
+ *
  */
 int render_deco_height(void);
diff --git a/include/shmlog.h b/include/shmlog.h
index b90211ef..dc8081f1 100644
--- a/include/shmlog.h
+++ b/include/shmlog.h
@@ -20,7 +20,7 @@
 /* Default shmlog size if not set by user. */
 extern const int default_shmlog_size;
 
-/*
+/**
  * Header of the shmlog file. Used by i3/src/log.c and i3/i3-dump-log/main.c.
  *
  */
diff --git a/include/util.h b/include/util.h
index 90ddc4a4..d08ac69d 100644
--- a/include/util.h
+++ b/include/util.h
@@ -125,7 +125,7 @@ void i3_restart(bool forget_layout);
 
 #if defined(__OpenBSD__) || defined(__APPLE__)
 
-/*
+/**
  * Taken from FreeBSD
  * Find the first occurrence of the byte string s in byte string l.
  *
diff --git a/libi3/draw_util.c b/libi3/draw_util.c
index 6a2e93dc..f88360dc 100644
--- a/libi3/draw_util.c
+++ b/libi3/draw_util.c
@@ -121,7 +121,7 @@ static void draw_util_set_source_color(surface_t *surface, color_t color) {
     cairo_set_source_rgba(surface->cr, color.red, color.green, color.blue, color.alpha);
 }
 
-/**
+/*
  * Draw the given text using libi3.
  * This function also marks the surface dirty which is needed if other means of
  * drawing are used. This will be the case when using XCB to draw text.
@@ -140,7 +140,7 @@ void draw_util_text(i3String *text, surface_t *surface, color_t fg_color, color_
     cairo_surface_mark_dirty(surface->surface);
 }
 
-/**
+/*
  * Draws a filled rectangle.
  * This function is a convenience wrapper and takes care of flushing the
  * surface as well as restoring the cairo state.
@@ -167,7 +167,7 @@ void draw_util_rectangle(surface_t *surface, color_t color, double x, double y,
     cairo_restore(surface->cr);
 }
 
-/**
+/*
  * Clears a surface with the given color.
  *
  */
@@ -191,7 +191,7 @@ void draw_util_clear_surface(surface_t *surface, color_t color) {
     cairo_restore(surface->cr);
 }
 
-/**
+/*
  * Copies a surface onto another surface.
  *
  */
diff --git a/libi3/string.c b/libi3/string.c
index a078b33e..9efa3690 100644
--- a/libi3/string.c
+++ b/libi3/string.c
@@ -99,7 +99,7 @@ i3String *i3string_from_ucs2(const xcb_char2b_t *from_ucs2, size_t num_glyphs) {
     return str;
 }
 
-/**
+/*
  * Copies the given i3string.
  * Note that this will not free the source string.
  */
diff --git a/src/commands.c b/src/commands.c
index 45ce1a3c..eecd59fc 100644
--- a/src/commands.c
+++ b/src/commands.c
@@ -330,7 +330,7 @@ void cmd_move_con_to_workspace(I3_CMD, const char *which) {
     ysuccess(true);
 }
 
-/**
+/*
  * Implementation of 'move [window|container] [to] workspace back_and_forth'.
  *
  */
diff --git a/src/con.c b/src/con.c
index d50c29be..c9ff44a2 100644
--- a/src/con.c
+++ b/src/con.c
@@ -312,7 +312,7 @@ bool con_has_managed_window(Con *con) {
     return (con != NULL && con->window != NULL && con->window->id != XCB_WINDOW_NONE && con_get_workspace(con) != NULL);
 }
 
-/**
+/*
  * Returns true if this node has regular or floating children.
  *
  */
@@ -526,7 +526,7 @@ Con *con_get_fullscreen_covering_ws(Con *ws) {
     return fs;
 }
 
-/**
+/*
  * Returns true if the container is internal, such as __i3_scratch
  *
  */
@@ -896,7 +896,7 @@ int con_num_children(Con *con) {
     return children;
 }
 
-/**
+/*
  * Returns the number of visible non-floating children of this container.
  * For example, if the container contains a hsplit which has two children,
  * this will return 2 instead of 1.
diff --git a/src/config.c b/src/config.c
index 74504bc1..9631b216 100644
--- a/src/config.c
+++ b/src/config.c
@@ -18,7 +18,7 @@ Config config;
 struct modes_head modes;
 struct barconfig_head barconfigs = TAILQ_HEAD_INITIALIZER(barconfigs);
 
-/**
+/*
  * Ungrabs all keys, to be called before re-grabbing the keys because of a
  * mapping_notify event or a configuration file reload
  *
diff --git a/src/floating.c b/src/floating.c
index be514ce2..96d7246c 100644
--- a/src/floating.c
+++ b/src/floating.c
@@ -59,7 +59,7 @@ static void floating_set_hint_atom(Con *con, bool floating) {
     xcb_flush(conn);
 }
 
-/**
+/*
  * Called when a floating window is created or resized.
  * This function resizes the window if its size is higher or lower than the
  * configured maximum/minimum size, respectively.
diff --git a/src/ipc.c b/src/ipc.c
index 3022d5b3..d0fb965c 100644
--- a/src/ipc.c
+++ b/src/ipc.c
@@ -1580,7 +1580,7 @@ void ipc_send_workspace_event(const char *change, Con *current, Con *old) {
     y(free);
 }
 
-/**
+/*
  * For the window events we send, along the usual "change" field,
  * also the window container, in "container".
  */
@@ -1610,7 +1610,7 @@ void ipc_send_window_event(const char *property, Con *con) {
     setlocale(LC_NUMERIC, "");
 }
 
-/**
+/*
  * For the barconfig update events, we send the serialized barconfig.
  */
 void ipc_send_barconfig_update_event(Barconfig *barconfig) {
diff --git a/src/main.c b/src/main.c
index eeeb3419..7eb47c82 100644
--- a/src/main.c
+++ b/src/main.c
@@ -32,7 +32,7 @@
  * RLIM_INFINITY for i3 debugging versions. */
 struct rlimit original_rlimit_core;
 
-/** The number of file descriptors passed via socket activation. */
+/* The number of file descriptors passed via socket activation. */
 int listen_fds;
 
 /* We keep the xcb_prepare watcher around to be able to enable and disable it
diff --git a/src/startup.c b/src/startup.c
index b1a2f602..f4ba85d8 100644
--- a/src/startup.c
+++ b/src/startup.c
@@ -95,7 +95,7 @@ static int _prune_startup_sequences(void) {
     return active_sequences;
 }
 
-/**
+/*
  * Deletes a startup sequence, ignoring whether its timeout has elapsed.
  * Useful when e.g. a window is moved between workspaces and its children
  * shouldn't spawn on the original workspace.
@@ -257,7 +257,7 @@ void startup_monitor_event(SnMonitorEvent *event, void *userdata) {
     }
 }
 
-/**
+/*
  * Renames workspaces that are mentioned in the startup sequences.
  *
  */
@@ -273,7 +273,7 @@ void startup_sequence_rename_workspace(const char *old_name, const char *new_nam
     }
 }
 
-/**
+/*
  * Gets the stored startup sequence for the _NET_STARTUP_ID of a given window.
  *
  */
diff --git a/src/workspace.c b/src/workspace.c
index 0cd72cf8..882dac54 100644
--- a/src/workspace.c
+++ b/src/workspace.c
@@ -914,7 +914,7 @@ Con *workspace_attach_to(Con *ws) {
     return new;
 }
 
-/**
+/*
  * Creates a new container and re-parents all of children from the given
  * workspace into it.
  *
@@ -949,7 +949,7 @@ Con *workspace_encapsulate(Con *ws) {
     return new;
 }
 
-/**
+/*
  * Move the given workspace to the specified output.
  * This returns true if and only if moving the workspace was successful.
  */
diff --git a/src/x.c b/src/x.c
index 581ec512..9d92167a 100644
--- a/src/x.c
+++ b/src/x.c
@@ -42,7 +42,7 @@ typedef struct con_state {
     bool child_mapped;
     bool is_hidden;
 
-    /** The con for which this state is. */
+    /* The con for which this state is. */
     Con *con;
 
     /* For reparenting, we have a flag (need_reparent) and the X ID of the old