diff --git a/include/cairo/context.hpp b/include/cairo/context.hpp index 5d2b4ee9..a937cd72 100644 --- a/include/cairo/context.hpp +++ b/include/cairo/context.hpp @@ -21,7 +21,7 @@ POLYBAR_NS namespace cairo { /** - * \brief Cairo context + * @brief Cairo context */ class context { public: diff --git a/include/cairo/font.hpp b/include/cairo/font.hpp index 4a45dbdb..67fe8f29 100644 --- a/include/cairo/font.hpp +++ b/include/cairo/font.hpp @@ -16,12 +16,12 @@ POLYBAR_NS namespace cairo { /** - * \brief Global pointer to the Freetype library handler + * @brief Global pointer to the Freetype library handler */ static FT_Library g_ftlib; /** - * \brief Abstract font face + * @brief Abstract font face */ class font { public: @@ -52,7 +52,7 @@ namespace cairo { }; /** - * \brief Font based on fontconfig/freetype + * @brief Font based on fontconfig/freetype */ class font_fc : public font { public: diff --git a/include/cairo/surface.hpp b/include/cairo/surface.hpp index 0c49bc78..0ec7f4ee 100644 --- a/include/cairo/surface.hpp +++ b/include/cairo/surface.hpp @@ -12,7 +12,7 @@ POLYBAR_NS namespace cairo { /** - * \brief Base surface + * @brief Base surface */ class surface { public: @@ -57,7 +57,7 @@ namespace cairo { }; /** - * \brief Surface for xcb + * @brief Surface for xcb */ class xcb_surface : public surface { public: diff --git a/include/cairo/utils.hpp b/include/cairo/utils.hpp index 5ed62496..5db3a145 100644 --- a/include/cairo/utils.hpp +++ b/include/cairo/utils.hpp @@ -10,7 +10,7 @@ POLYBAR_NS namespace cairo { namespace utils { /** - * \brief RAII wrapper used acquire cairo_device_t + * @brief RAII wrapper used acquire cairo_device_t */ class device_lock { public: @@ -24,7 +24,7 @@ namespace cairo { }; /** - * \brief RAII wrapper used to access the underlying + * @brief RAII wrapper used to access the underlying * FT_Face of a scaled font face */ class ft_face_lock { @@ -39,7 +39,7 @@ namespace cairo { }; /** - * \brief Unicode character containing converted codepoint + * @brief Unicode character containing converted codepoint * and details on where its position in the source string */ struct unicode_character { @@ -51,17 +51,17 @@ namespace cairo { using unicode_charlist = std::list; /** - * \see + * @see */ cairo_operator_t str2operator(const string& mode, cairo_operator_t fallback); /** - * \brief Create a UCS-4 codepoint from a utf-8 encoded string + * @brief Create a UCS-4 codepoint from a utf-8 encoded string */ bool utf8_to_ucs4(const unsigned char* src, unicode_charlist& result_list); /** - * \brief Convert a UCS-4 codepoint to a utf-8 encoded string + * @brief Convert a UCS-4 codepoint to a utf-8 encoded string */ size_t ucs4_to_utf8(char* utf8, unsigned int ucs); } diff --git a/include/components/config.hpp b/include/components/config.hpp index d5c6ecbd..33936fdd 100644 --- a/include/components/config.hpp +++ b/include/components/config.hpp @@ -36,7 +36,7 @@ class config { static constexpr const char* BAR_PREFIX = "bar/"; /** - * \brief Instruct the config to connect to the xresource manager + * @brief Instruct the config to connect to the xresource manager */ void use_xrm(); @@ -229,7 +229,7 @@ class config { } /** - * \see deprecated + * @see deprecated */ template T deprecated_list(const string& section, const string& old, const string& newkey, const vector& fallback) const { diff --git a/include/components/config_parser.hpp b/include/components/config_parser.hpp index 0513f319..35c56781 100644 --- a/include/components/config_parser.hpp +++ b/include/components/config_parser.hpp @@ -12,7 +12,7 @@ POLYBAR_NS DEFINE_ERROR(parser_error); /** - * \brief Exception object for syntax errors + * @brief Exception object for syntax errors * * Contains filepath and line number where syntax error was found */ @@ -46,12 +46,12 @@ class invalid_name_error : public syntax_error { }; /** - * \brief All different types a line in a config can be + * @brief All different types a line in a config can be */ enum class line_type { KEY, HEADER, COMMENT, EMPTY, UNKNOWN }; /** - * \brief Storage for a single config line + * @brief Storage for a single config line * * More sanitized than the actual string of the comment line, with information * about line type and structure @@ -98,23 +98,23 @@ class config_parser { config_parser(logger&& logger, string&& file, string&& bar) = delete; /** - * \brief Performs the parsing of the main config file m_file + * @brief Performs the parsing of the main config file m_file * - * \returns config class instance populated with the parsed config + * @returns config class instance populated with the parsed config * - * \throws syntax_error If there was any kind of syntax error - * \throws parser_error If aynthing else went wrong + * @throws syntax_error If there was any kind of syntax error + * @throws parser_error If aynthing else went wrong */ config::make_type parse(); protected: /** - * \brief Converts the `lines` vector to a proper sectionmap + * @brief Converts the `lines` vector to a proper sectionmap */ sectionmap_t create_sectionmap(); /** - * \brief Parses the given file, extracts key-value pairs and section + * @brief Parses the given file, extracts key-value pairs and section * headers and adds them onto the `lines` vector * * This method directly resolves `include-file` directives and checks for @@ -125,7 +125,7 @@ class config_parser { void parse_file(const string& file, file_list path); /** - * \brief Parses the given line string to the given line_t struct + * @brief Parses the given line string to the given line_t struct * * We use the INI file syntax (https://en.wikipedia.org/wiki/INI_file) * Whitespaces (tested with isspace()) at the beginning and end of a line are ignored @@ -153,7 +153,7 @@ class config_parser { * * sections are defined as [section], everything inside the square brackets is part of the name * - * \throws syntax_error if the line isn't well formed. The syntax error + * @throws syntax_error if the line isn't well formed. The syntax error * does not contain the filename or line numbers because parse_line * doesn't know about those. Whoever calls parse_line needs to * catch those exceptions and set the file path and line number @@ -161,7 +161,7 @@ class config_parser { void parse_line(line_t& line, const string& line_str); /** - * \brief Determines the type of a line read from a config file + * @brief Determines the type of a line read from a config file * * Expects that line is trimmed * This mainly looks at the first character and doesn't check if the line is @@ -174,33 +174,33 @@ class config_parser { static line_type get_line_type(const string& line); /** - * \brief Parse a line containing a section header and returns the header name + * @brief Parse a line containing a section header and returns the header name * * Only assumes that the line starts with '[' and is trimmed * - * \throws syntax_error if the line doesn't end with ']' or the header name + * @throws syntax_error if the line doesn't end with ']' or the header name * contains forbidden characters */ string parse_header(const line_t& line, const string& line_str); /** - * \brief Parses a line containing a key-value pair and returns the key name + * @brief Parses a line containing a key-value pair and returns the key name * and the value string inside an std::pair * * Only assumes that the line contains '=' at least once and is trimmed * - * \throws syntax_error if the key contains forbidden characters + * @throws syntax_error if the key contains forbidden characters */ std::pair parse_key(const line_t& line, const string& line_str); /** - * \brief Parses the given value, checks if the given value contains + * @brief Parses the given value, checks if the given value contains * one or more unescaped backslashes and logs an error if yes */ string parse_escaped_value(const line_t& line, string&& value, const string& key); /** - * \brief Name of all the files the config includes values from + * @brief Name of all the files the config includes values from * * The line_t struct uses indices to this vector to map lines to their * original files. This allows us to point the user to the exact location @@ -210,7 +210,7 @@ class config_parser { private: /** - * \brief Checks if the given name doesn't contain any spaces or characters + * @brief Checks if the given name doesn't contain any spaces or characters * in config_parser::m_forbidden_chars */ bool is_valid_name(const string& name); @@ -218,7 +218,7 @@ class config_parser { vector get_bars(const sectionmap_t& sections) const; /** - * \brief Whether or not an xresource manager should be used + * @brief Whether or not an xresource manager should be used * * Is set to true if any ${xrdb...} references are found */ @@ -227,7 +227,7 @@ class config_parser { const logger& m_log; /** - * \brief Absolute path to the main config file + * @brief Absolute path to the main config file */ string m_config; @@ -237,7 +237,7 @@ class config_parser { string m_barname; /** - * \brief List of all the lines in the config (with included files) + * @brief List of all the lines in the config (with included files) * * The order here matters, as we have not yet associated key-value pairs * with sections @@ -245,12 +245,12 @@ class config_parser { vector m_lines; /** - * \brief None of these characters can be used in the key and section names + * @brief None of these characters can be used in the key and section names */ const string m_forbidden_chars{"\"'=;#[](){}:.$\\%"}; /** - * \brief List of names that cannot be used as section names + * @brief List of names that cannot be used as section names * * These strings have a special meaning inside references and so the * section [self] could never be referenced. diff --git a/include/components/controller.hpp b/include/components/controller.hpp index 7c64ae10..24efa360 100644 --- a/include/components/controller.hpp +++ b/include/components/controller.hpp @@ -102,7 +102,7 @@ class controller : public signal_receiver m_modules; /** - * \brief Loaded modules grouped by block + * @brief Loaded modules grouped by block */ modulemap_t m_blocks; /** - * \brief Flag to trigger reload after shutdown + * @brief Flag to trigger reload after shutdown */ bool m_reload{false}; }; diff --git a/include/components/eventloop.hpp b/include/components/eventloop.hpp index 39848713..1a3610aa 100644 --- a/include/components/eventloop.hpp +++ b/include/components/eventloop.hpp @@ -76,10 +76,10 @@ namespace eventloop { /** * Generic callback function that can be used for all uv handle callbacks. * - * \tparam Event Event class/struct. Must have a constructor that takes all arguments passed to the uv callback, + * @tparam Event Event class/struct. Must have a constructor that takes all arguments passed to the uv callback, * except for the handle argument. - * \tparam Member Pointer to class member where callback function is stored - * \tparam Args Additional arguments in the uv callback. Inferred by the compiler + * @tparam Member Pointer to class member where callback function is stored + * @tparam Args Additional arguments in the uv callback. Inferred by the compiler */ template Self::*Member, typename... Args> static void event_cb(H* handle, Args... args) { diff --git a/include/events/signal_emitter.hpp b/include/events/signal_emitter.hpp index 10c03ce4..aa11b0dd 100644 --- a/include/events/signal_emitter.hpp +++ b/include/events/signal_emitter.hpp @@ -7,7 +7,7 @@ POLYBAR_NS /** - * \brief Holds all signal receivers attached to the emitter + * @brief Holds all signal receivers attached to the emitter */ extern signal_receivers_t g_signal_receivers; diff --git a/include/modules/date.hpp b/include/modules/date.hpp index 57039a37..ee5c5a79 100644 --- a/include/modules/date.hpp +++ b/include/modules/date.hpp @@ -26,7 +26,7 @@ namespace modules { private: static constexpr auto TAG_LABEL = "