From b6f819cf42f9ae15f8d9c2b3122ec7c9e345e657 Mon Sep 17 00:00:00 2001 From: Sergey Naumov Date: Thu, 21 Apr 2016 06:55:26 +0300 Subject: [PATCH] Doc-comments fix --- include/i3ipc++/ipc-util.hpp | 10 ++--- include/i3ipc++/ipc.hpp | 86 ++++++++++++++++++------------------ 2 files changed, 48 insertions(+), 48 deletions(-) diff --git a/include/i3ipc++/ipc-util.hpp b/include/i3ipc++/ipc-util.hpp index b046eea..a25d3f8 100644 --- a/include/i3ipc++/ipc-util.hpp +++ b/include/i3ipc++/ipc-util.hpp @@ -23,9 +23,9 @@ namespace i3ipc { */ struct header_t { /* 6 = strlen(I3_IPC_MAGIC) */ - char magic[6]; /**< Magic string @see I3_IPC_MAGIC */ - uint32_t size; /**< Size of payload */ - uint32_t type; /**< Message type */ + char magic[6]; ///< Magic string @see I3_IPC_MAGIC + uint32_t size; ///< Size of payload + uint32_t type; ///< Message type } __attribute__ ((packed)); @@ -84,8 +84,8 @@ enum class ReplyType : uint32_t { * @brief i3 IPC message buffer */ struct buf_t { - uint32_t size; /**< @brief Size of whole buffer */ - uint8_t* data; /**< @brief Pointer to the message */ + uint32_t size; ///< @brief Size of whole buffer + uint8_t* data; ///< @brief Pointer to the message /** * @brief i3 IPC message header diff --git a/include/i3ipc++/ipc.hpp b/include/i3ipc++/ipc.hpp index ad6287a..15c66fd 100644 --- a/include/i3ipc++/ipc.hpp +++ b/include/i3ipc++/ipc.hpp @@ -27,44 +27,44 @@ std::string get_socketpath(); * Primitive of rectangle */ struct rect_t { - int x; /**< Position on X axis */ - int y; /**< Position on Y axis */ - int width; /**< Width of rectangle */ - int height; /**< Height of rectangle */ + int x; ///< Position on X axis + int y; ///< Position on Y axis + int width; ///< Width of rectangle + int height; ///< Height of rectangle }; /** * i3's workspace */ struct workspace_t { - int num; /**< Index of the worksapce */ - std::string name; /**< Name of the workspace */ - bool visible; /**< Is the workspace visible */ - bool focused; /**< Is the workspace is currently focused */ - bool urgent; /**< Is the workspace is urgent */ - rect_t rect; /**< A size of the workspace */ - std::string output; /**< An output of the workspace */ + int num; ///< Index of the worksapce + std::string name; ///< Name of the workspace + bool visible; ///< Is the workspace visible + bool focused; ///< Is the workspace is currently focused + bool urgent; ///< Is the workspace is urgent + rect_t rect; ///< A size of the workspace + std::string output; ///< An output of the workspace }; /** * i3's output */ struct output_t { - std::string name; /**< Name of the output */ - bool active; /**< Is the output currently active */ - std::string current_workspace; /**< Name of current workspace */ - rect_t rect; /**< Size of the output */ + std::string name; ///< Name of the output + bool active; ///< Is the output currently active + std::string current_workspace; ///< Name of current workspace + rect_t rect; ///< Size of the output }; /** * Version of i3 */ struct version_t { - std::string human_readable; /**< Human redable version string */ - std::string loaded_config_file_name; /**< Path to current config of i3 */ - uint32_t major; /**< Major version of i3 */ - uint32_t minor; /**< Minor version of i3 */ - uint32_t patch; /**< Patch number of i3 */ + std::string human_readable; ///< Human redable version string + std::string loaded_config_file_name; ///< Path to current config of i3 + uint32_t major; ///< Major version of i3 + uint32_t minor; ///< Minor version of i3 + uint32_t patch; ///< Patch number of i3 }; @@ -72,35 +72,35 @@ struct version_t { * Types of the events of i3 */ enum EventType { - ET_WORKSPACE = (1 << 0), /**< Workspace event */ - ET_OUTPUT = (1 << 1), /**< Output event */ - ET_MODE = (1 << 2), /**< Output mode event */ - ET_WINDOW = (1 << 3), /**< Window event */ - ET_BARCONFIG_UPDATE = (1 << 4), /**< Bar config update event @attention Yet is not implemented as signal in I3Connection */ + ET_WORKSPACE = (1 << 0), ///< Workspace event + ET_OUTPUT = (1 << 1), ///< Output event + ET_MODE = (1 << 2), ///< Output mode event + ET_WINDOW = (1 << 3), ///< Window event + ET_BARCONFIG_UPDATE = (1 << 4), ///< Bar config update event @attention Yet is not implemented as signal in I3Connection }; /** * Types of workspace events */ enum class WorkspaceEventType : char { - FOCUS = 'f', /**< Focused */ - INIT = 'i', /**< Initialized */ - EMPTY = 'e', /**< Became empty */ - URGENT = 'u', /**< Became urgent */ + FOCUS = 'f', ///< Focused + INIT = 'i', ///< Initialized + EMPTY = 'e', ///< Became empty + URGENT = 'u', ///< Became urgent }; /** * Types of window events */ enum class WindowEventType : char { - NEW = 'n', /**< Window created */ - CLOSE = 'c', /**< Window closed */ - FOCUS = 'f', /**< Window got focus */ - TITLE = 't', /**< Title of window has been changed */ - FULLSCREEN_MODE = 'F', /**< Window toggled to fullscreen mode */ - MOVE = 'M', /**< Window moved */ - FLOATING = '_', /**< Window toggled floating mode */ - URGENT = 'u', /**< Window became urgent */ + NEW = 'n', ///< Window created + CLOSE = 'c', ///< Window closed + FOCUS = 'f', ///< Window got focus + TITLE = 't', ///< Title of window has been changed + FULLSCREEN_MODE = 'F', ///< Window toggled to fullscreen mode + MOVE = 'M', ///< Window moved + FLOATING = '_', ///< Window toggled floating mode + URGENT = 'u', ///< Window became urgent }; @@ -226,12 +226,12 @@ public: */ void handle_event(); - sigc::signal signal_workspace_event; /**< Workspace event signal */ - sigc::signal signal_output_event; /**< Output event signal */ - sigc::signal signal_mode_event; /**< Output mode event signal */ - sigc::signal signal_window_event; /**< Window event signal */ - sigc::signal signal_barconfig_update_event; /**< Barconfig update event signal */ - sigc::signal&> signal_event; /**< i3 event signal @note Default handler routes event to signal according to type */ + sigc::signal signal_workspace_event; ///< Workspace event signal + sigc::signal signal_output_event; ///< Output event signal + sigc::signal signal_mode_event; ///< Output mode event signal + sigc::signal signal_window_event; ///< Window event signal + sigc::signal signal_barconfig_update_event; ///< Barconfig update event signal + sigc::signal&> signal_event; ///< i3 event signal @note Default handler routes event to signal according to type private: const int32_t m_main_socket; int32_t m_event_socket;