]> git.sur5r.net Git - i3/i3/commitdiff
Make comment style more consistent
authorOrestis Floros <orestisf1993@gmail.com>
Sat, 21 Apr 2018 10:02:14 +0000 (13:02 +0300)
committerOrestis Floros <orestisf1993@gmail.com>
Sat, 13 Oct 2018 18:10:10 +0000 (21:10 +0300)
21 files changed:
include/commands.h
include/commands_parser.h
include/con.h
include/config_parser.h
include/libi3.h
include/match.h
include/randr.h
include/render.h
include/shmlog.h
include/util.h
libi3/draw_util.c
libi3/string.c
src/commands.c
src/con.c
src/config.c
src/floating.c
src/ipc.c
src/main.c
src/startup.c
src/workspace.c
src/x.c

index b4b3da386b59b67da4e5d5a8b2457d60c9ca3df5..0137460feae0624218af57ec10d2426ab6b5dc6b 100644 (file)
@@ -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'
  *
  */
index 88b3f6d09c6540972b701907fea56dcf071f8642..b65ae93f85c51e16d49806a232bf1d272b7477a8 100644 (file)
@@ -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.
index 672d80ac882ed6049ba48b852d70d616f29f7255..2c991b0cb6ec90b91ccbe82fc314a7f3edfe6e9c 100644 (file)
@@ -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
index ace4041dd2ab2e4169b838330e5ef54f690ce0ce..009538f2d40625d31ba19976aeab2e4d88a63a8f 100644 (file)
@@ -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.
index bcd2b7b106647ad33b550cf7490da6d90865d834..790baba98578d3903ee651cba6e4b47fb8eb7456 100644 (file)
@@ -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.
index 4ff8c485bbed18fd45a27e290b7a40368f382882..043c3a8f114e77401a5a5df2f8792b8780e4f150 100644 (file)
@@ -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.
index 39182c54b3e76d0851cebeb7d3ed99f68e4109b3..ec533a28045f92f4719c4f810efd8b56d0fa90f2 100644 (file)
@@ -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.
  *
  */
index 750b7d310317901155a626656517db9102afedde..2b2c8dad74b291347144e9dc9189da570cb9c695 100644 (file)
 
 #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);
index b90211ef1a9ca5a612e71a3028eb65f984fb77ab..dc8081f1329c8e6a24d2646c19428127efe594ce 100644 (file)
@@ -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.
  *
  */
index 90ddc4a4615b97943e1283710d73f651aa68c8c4..d08ac69df9cc4205dfcc791b7d8b76f77baa943e 100644 (file)
@@ -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.
  *
index 6a2e93dcd8e3a413099e2e34b119fcfbf13faf93..f88360dc32ecab74a146a6e7e35789c9c35efc0b 100644 (file)
@@ -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.
  *
  */
index a078b33e2b955494f34a2a7c37c21c398bd1a2bc..9efa369037a9b96a8d115dfd4c4366afa7873fdc 100644 (file)
@@ -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.
  */
index 45ce1a3c62645e961d86f41adf446e4582861112..eecd59fc063f4f7cff0ff9c398ce1bcc3c205c3c 100644 (file)
@@ -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'.
  *
  */
index d50c29be7a64003a92ad9ba0ca6eae330c4deebd..c9ff44a2cd484913065b8993b105375de9125e6c 100644 (file)
--- 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.
index 74504bc12e93d130f24d13b4103b4fa90771d7d0..9631b2160237732ed404ad02757ab064b8d87b9b 100644 (file)
@@ -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
  *
index be514ce20e259f6f5db222bfc9639474f8e3eb54..96d7246c15950119f2e97f0d8ff51362bb36ab1f 100644 (file)
@@ -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.
index 3022d5b399bd99d6f382a33e9d533e0f2cb85b4d..d0fb965c3d8e55dafbd5fdbd8c97f63e1794d913 100644 (file)
--- 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) {
index eeeb3419c366b959feb01d5f7a9fefd27c540eda..7eb47c822fa83550b0d61df0f8d127a27cac1e8d 100644 (file)
@@ -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
index b1a2f60215550d9585a7f24efbebb243e2c672cd..f4ba85d8681624e10685849c386065698a0b6ee9 100644 (file)
@@ -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.
  *
  */
index 0cd72cf80c3bc19b32741321ae94e168bbe4a950..882dac5449fca7c0a5f64f346be1406050431e6b 100644 (file)
@@ -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 581ec5129d17bd8c9e0656e46c315c31b9e5ecb2..9d92167ab643835ec2fc147f3f11dc3fdfd3b2a5 100644 (file)
--- 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