Mercurial > irccd
changeset 374:e9adab218027
Misc: various code cleanup
line wrap: on
line diff
--- a/CMakeLists.txt Thu Dec 08 13:17:26 2016 +0100 +++ b/CMakeLists.txt Thu Dec 08 20:06:38 2016 +0100 @@ -17,24 +17,25 @@ # # -# Where to start -# --------------------------------------------------------- +# Where to start. +# ------------------------------------------------------------------- # -# If you plan to modify the build system there are several places to look to do what you want. +# If you plan to modify the build system there are several places to look to do +# what you want. # # cmake/IrccdOptions.cmake - User definable options. # cmake/IrccdPackage.cmake - Package creation. # cmake/IrccdSystem.cmake - Contains some platforms checks and compile flags. # cmake/IrccdVersion.cmake - Defines the Irccd version and its plugins. # cmake/check - Platform checks in separate files. -# cmake/function - Custom functions. +# cmake/function - Custom CMake functions. # cmake/installer - Some files for the QtIFW installer. # cmake/internal - Some internal files (e.g. the sysconfig.h) # cmake/packages - Additional find_package modules. # # Build system is then processed in different directories: # -# contrib - User contributions not maintained by irccd authors. +# contrib - User contributions. # doc - The documentation process. # extern - External libraries. # lib - The irccd library
--- a/cmake/IrccdOptions.cmake Thu Dec 08 13:17:26 2016 +0100 +++ b/cmake/IrccdOptions.cmake Thu Dec 08 20:06:38 2016 +0100 @@ -89,9 +89,10 @@ set(WITH_TEST_IRCHOST "127.0.0.1" CACHE STRING "IRC host for tests") set(WITH_TEST_IRCPORT 6667 CACHE STRING "IRC port for test") -# --------------------------------------------------------- -# Installation paths -# --------------------------------------------------------- +# +# Installation paths. +# ------------------------------------------------------------------- +# set(WITH_BINDIR "bin" CACHE STRING "Binary directory") set(WITH_MANDIR "share/man" CACHE STRING "Man directory") @@ -127,9 +128,10 @@ endif () endforeach () -# --------------------------------------------------------- -# Internal dependencies -# --------------------------------------------------------- +# +# Internal dependencies. +# ------------------------------------------------------------------- +# if (WITH_JS) add_subdirectory(extern/duktape) @@ -145,9 +147,10 @@ set(WITH_TESTS_MSG "No") endif () -# --------------------------------------------------------- -# External dependencies -# --------------------------------------------------------- +# +# External dependencies. +# ------------------------------------------------------------------- +# find_package(Doxygen) find_package(Pandoc)
--- a/cmake/IrccdSystem.cmake Thu Dec 08 13:17:26 2016 +0100 +++ b/cmake/IrccdSystem.cmake Thu Dec 08 20:06:38 2016 +0100 @@ -22,9 +22,10 @@ include(CheckSymbolExists) include(CheckTypeSize) -# --------------------------------------------------------- -# Global compile flags -# --------------------------------------------------------- +# +# Global compile flags. +# ------------------------------------------------------------------- +# # # Recent versions of CMake has nice C++ feature detection for modern @@ -77,9 +78,10 @@ file(MAKE_DIRECTORY ${IRCCD_FAKEROOTDIR}) endif () -# --------------------------------------------------------- -# System identification -# --------------------------------------------------------- +# +# System identification. +# ------------------------------------------------------------------- +# if (WIN32) set(IRCCD_SYSTEM_WINDOWS TRUE) @@ -95,9 +97,10 @@ set(IRCCD_SYSTEM_LINUX TRUE) endif () -# --------------------------------------------------------- -# Portability requirements -# --------------------------------------------------------- +# +# Portability requirements. +# ------------------------------------------------------------------- +# check_type_size(int8_t HAVE_INT8) check_type_size(uint8_t HAVE_UINT8)
--- a/cmake/function/IrccdBuildHtml.cmake Thu Dec 08 13:17:26 2016 +0100 +++ b/cmake/function/IrccdBuildHtml.cmake Thu Dec 08 20:06:38 2016 +0100 @@ -100,11 +100,6 @@ set(baseurl "./") endif () -# message("==> dumping ${HTML_SOURCE} <==") -# message(" -> basename: ${basename}") -# message(" -> dirname: ${dirname}") -# message(" -> baseurl: ${baseurl}") - # Replace CMake variables. configure_file( ${HTML_SOURCE}
--- a/cmake/internal/sysconfig.hpp.in Thu Dec 08 13:17:26 2016 +0100 +++ b/cmake/internal/sysconfig.hpp.in Thu Dec 08 20:06:38 2016 +0100 @@ -19,8 +19,6 @@ #ifndef IRCCD_SYSCONFIG_H #define IRCCD_SYSCONFIG_H - - /* * Fix annoying "Please include winsock2.h before windows.h" */
--- a/irccdctl/alias.hpp Thu Dec 08 13:17:26 2016 +0100 +++ b/irccdctl/alias.hpp Thu Dec 08 20:06:38 2016 +0100 @@ -33,7 +33,6 @@ namespace irccd { /** - * \class AliasArg * \brief Describe an alias argument. * * When the user specify arguments, it can precise an applied argument or a @@ -91,7 +90,6 @@ }; /** - * \class AliasCommand * \brief Describe a user-provided alias command. * * An alias command is just a command with a set of applied or placeholders @@ -137,7 +135,6 @@ }; /** - * \class Alias * \brief A set of commands to execute with their arguments. * * An alias is a composition of AliasCommand, typically, the user is able to set
--- a/libcommon/irccd/elapsed-timer.hpp Thu Dec 08 13:17:26 2016 +0100 +++ b/libcommon/irccd/elapsed-timer.hpp Thu Dec 08 20:06:38 2016 +0100 @@ -31,7 +31,6 @@ namespace irccd { /** - * \class ElapsedTimer * \brief Measure elapsed time * * This class provides an abstraction to measure elapsed time since the
--- a/libcommon/irccd/fs.hpp Thu Dec 08 13:17:26 2016 +0100 +++ b/libcommon/irccd/fs.hpp Thu Dec 08 20:06:38 2016 +0100 @@ -16,8 +16,8 @@ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -#ifndef FS_HPP -#define FS_HPP +#ifndef IRCCD_FS_HPP +#define IRCCD_FS_HPP /** * \file fs.hpp @@ -71,7 +71,6 @@ }; /** - * \class Entry * \brief Entry in the directory list. */ class Entry { @@ -356,4 +355,4 @@ } // !irccd -#endif // !FS_HPP +#endif // !IRCCD_FS_HPP
--- a/libcommon/irccd/ini.hpp Thu Dec 08 13:17:26 2016 +0100 +++ b/libcommon/irccd/ini.hpp Thu Dec 08 20:06:38 2016 +0100 @@ -16,8 +16,8 @@ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -#ifndef INI_HPP -#define INI_HPP +#ifndef IRCCD_INI_HPP +#define IRCCD_INI_HPP /** * \file ini.hpp @@ -62,7 +62,7 @@ * ````ini * [section] * value = "1" - * + * * [section] * value = "2" * ```` @@ -122,7 +122,6 @@ class Document; /** - * \class Error * \brief Error in a file. */ class Error : public std::exception { @@ -178,7 +177,6 @@ }; /** - * \class Token * \brief Describe a token read in the .ini source. * * This class can be used when you want to parse a .ini file yourself. @@ -295,7 +293,6 @@ using Tokens = std::vector<Token>; /** - * \class Option * \brief Option definition. */ class Option : public std::vector<std::string> { @@ -369,7 +366,6 @@ }; /** - * \class Section * \brief Section that contains one or more options. */ class Section : public std::vector<Option> { @@ -471,7 +467,6 @@ }; /** - * \class Document * \brief Ini document description. * \see readFile * \see readString @@ -613,4 +608,4 @@ } // !irccd -#endif // !INI_HPP +#endif // !IRCCD_INI_HPP
--- a/libcommon/irccd/logger.hpp Thu Dec 08 13:17:26 2016 +0100 +++ b/libcommon/irccd/logger.hpp Thu Dec 08 20:06:38 2016 +0100 @@ -52,11 +52,6 @@ class Logger { public: /** - * Default constructor. - */ - Logger() = default; - - /** * Virtual destructor defaulted. */ virtual ~Logger() = default; @@ -105,11 +100,6 @@ class Filter { public: /** - * Default constructor. - */ - Filter() = default; - - /** * Virtual destructor defaulted. */ virtual ~Filter() = default; @@ -159,8 +149,6 @@ */ class ConsoleLogger : public Logger { public: - IRCCD_EXPORT ConsoleLogger() = default; - /** * \copydoc Logger::debug */ @@ -227,8 +215,6 @@ */ class SilentLogger : public Logger { public: - IRCCD_EXPORT SilentLogger() = default; - /** * \copydoc Logger::debug */
--- a/libcommon/irccd/options.hpp Thu Dec 08 13:17:26 2016 +0100 +++ b/libcommon/irccd/options.hpp Thu Dec 08 20:06:38 2016 +0100 @@ -16,8 +16,8 @@ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -#ifndef OPTIONS_HPP -#define OPTIONS_HPP +#ifndef IRCCD_OPTIONS_HPP +#define IRCCD_OPTIONS_HPP /** * \file options.hpp @@ -153,4 +153,4 @@ } // !irccd -#endif // !OPTIONS_HPP +#endif // !IRCCD_OPTIONS_HPP
--- a/libcommon/irccd/path.cpp Thu Dec 08 13:17:26 2016 +0100 +++ b/libcommon/irccd/path.cpp Thu Dec 08 20:06:38 2016 +0100 @@ -79,6 +79,13 @@ std::string base{"."}; +/* + * executablePath. + * ------------------------------------------------------------------ + * + * Get the executable directory. + */ + #if defined(IRCCD_SYSTEM_WINDOWS) std::string executablePath() @@ -166,7 +173,7 @@ #endif /* - * System paths + * System paths. * ------------------------------------------------------------------ * * Compute system paths. @@ -200,14 +207,14 @@ } /* - * User paths + * User paths. * ------------------------------------------------------------------ * * Compute user paths. */ /* - * userConfig + * userConfig. * --------------------------------------------------------- * * Get the path directory to the user configuration. Example: @@ -254,7 +261,7 @@ } /* - * userData + * userData. * -------------------------------------------------------- * * Get the path to the data application. @@ -301,7 +308,7 @@ } /* - * userCache + * userCache. * -------------------------------------------------------- * * Directory for cache files. @@ -345,7 +352,7 @@ } /* - * userPlugins + * userPlugins. * -------------------------------------------------------- * * Path to the data + plugins.
--- a/libcommon/irccd/signals.hpp Thu Dec 08 13:17:26 2016 +0100 +++ b/libcommon/irccd/signals.hpp Thu Dec 08 20:06:38 2016 +0100 @@ -32,7 +32,6 @@ namespace irccd { /** - * \class SignalConnection * \brief Stores the reference to the callable * * This class can be stored to remove a registered function from a Signal, be careful to not mix connections between different signals as @@ -65,7 +64,6 @@ }; /** - * \class Signal * \brief Stores and call registered functions * * This class is intended to be use as a public field in the desired object.
--- a/libcommon/irccd/system.cpp Thu Dec 08 13:17:26 2016 +0100 +++ b/libcommon/irccd/system.cpp Thu Dec 08 20:06:38 2016 +0100 @@ -78,7 +78,7 @@ namespace { /* - * setHelper + * setHelper. * ------------------------------------------------------------------ * * This is an helper for setting the uid or gid. It accepts both numeric and
--- a/libcommon/irccd/util.hpp Thu Dec 08 13:17:26 2016 +0100 +++ b/libcommon/irccd/util.hpp Thu Dec 08 20:06:38 2016 +0100 @@ -69,7 +69,6 @@ using MessagePair = std::pair<std::string, MessageType>; /** - * \class Substitution * \brief Used for format() function. */ class Substitution {
--- a/libcommon/irccd/xdg.hpp Thu Dec 08 13:17:26 2016 +0100 +++ b/libcommon/irccd/xdg.hpp Thu Dec 08 20:06:38 2016 +0100 @@ -16,8 +16,8 @@ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -#ifndef XDG_HPP -#define XDG_HPP +#ifndef IRCCD_XDG_HPP +#define IRCCD_XDG_HPP /** * \file xdg.hpp @@ -34,7 +34,6 @@ namespace irccd { /** - * \class Xdg * \brief XDG directory specifications. * * Read and get XDG directories. @@ -187,4 +186,4 @@ } // !irccd -#endif // !XDG_HPP +#endif // !IRCCD_XDG_HPP
--- a/libirccd-js/irccd/duktape.hpp Thu Dec 08 13:17:26 2016 +0100 +++ b/libirccd-js/irccd/duktape.hpp Thu Dec 08 20:06:38 2016 +0100 @@ -38,7 +38,6 @@ namespace irccd { /** - * \class StackAssert * \brief Stack sanity checker. * * Instanciate this class where you need to manipulate the Duktape stack outside a Duktape/C function, its destructor @@ -100,7 +99,6 @@ }; /** - * \class Exception * \brief Error description. * * This class fills the fields got in an Error object. @@ -182,7 +180,6 @@ }; /** - * \class Error * \brief Base ECMAScript error class. * \warning Override the function create for your own exceptions */ @@ -228,7 +225,6 @@ }; /** - * \class EvalError * \brief Error in eval() function. */ class EvalError : public Error { @@ -245,7 +241,6 @@ }; /** - * \class RangeError * \brief Value is out of range. */ class RangeError : public Error { @@ -262,7 +257,6 @@ }; /** - * \class ReferenceError * \brief Trying to use a variable that does not exist. */ class ReferenceError : public Error { @@ -279,7 +273,6 @@ }; /** - * \class SyntaxError * \brief Syntax error in the script. */ class SyntaxError : public Error { @@ -296,7 +289,6 @@ }; /** - * \class TypeError * \brief Invalid type given. */ class TypeError : public Error { @@ -313,7 +305,6 @@ }; /** - * \class URIError * \brief URI manipulation failure. */ class URIError : public Error {
--- a/libirccd-js/irccd/mod-directory.cpp Thu Dec 08 13:17:26 2016 +0100 +++ b/libirccd-js/irccd/mod-directory.cpp Thu Dec 08 20:06:38 2016 +0100 @@ -1,5 +1,5 @@ /* - * js-directory.cpp -- Irccd.Directory API + * mod-directory.cpp -- Irccd.Directory API * * Copyright (c) 2013-2016 David Demelier <markand@malikania.fr> *
--- a/libirccd-js/irccd/mod-elapsed-timer.cpp Thu Dec 08 13:17:26 2016 +0100 +++ b/libirccd-js/irccd/mod-elapsed-timer.cpp Thu Dec 08 20:06:38 2016 +0100 @@ -1,5 +1,5 @@ /* - * js-elapsed-timer.cpp -- Irccd.ElapsedTimer API + * mod-elapsed-timer.cpp -- Irccd.ElapsedTimer API * * Copyright (c) 2013-2016 David Demelier <markand@malikania.fr> *
--- a/libirccd-js/irccd/mod-file.cpp Thu Dec 08 13:17:26 2016 +0100 +++ b/libirccd-js/irccd/mod-file.cpp Thu Dec 08 20:06:38 2016 +0100 @@ -1,5 +1,5 @@ /* - * js-file.cpp -- Irccd.File API + * mod-file.cpp -- Irccd.File API * * Copyright (c) 2013-2016 David Demelier <markand@malikania.fr> *
--- a/libirccd-js/irccd/mod-file.hpp Thu Dec 08 13:17:26 2016 +0100 +++ b/libirccd-js/irccd/mod-file.hpp Thu Dec 08 20:06:38 2016 +0100 @@ -38,7 +38,6 @@ namespace irccd { /** - * \class File * \brief Object for Javascript to perform I/O. * * This class can be constructed to Javascript.
--- a/libirccd-js/irccd/mod-irccd.cpp Thu Dec 08 13:17:26 2016 +0100 +++ b/libirccd-js/irccd/mod-irccd.cpp Thu Dec 08 20:06:38 2016 +0100 @@ -1,5 +1,5 @@ /* - * js-irccd.cpp -- Irccd API + * mod-irccd.cpp -- Irccd API * * Copyright (c) 2013-2016 David Demelier <markand@malikania.fr> *
--- a/libirccd-js/irccd/mod-plugin.cpp Thu Dec 08 13:17:26 2016 +0100 +++ b/libirccd-js/irccd/mod-plugin.cpp Thu Dec 08 20:06:38 2016 +0100 @@ -1,5 +1,5 @@ /* - * js-plugin->cpp -- Irccd.Plugin API + * mod-plugin.cpp -- Irccd.Plugin API * * Copyright (c) 2013-2016 David Demelier <markand@malikania.fr> *
--- a/libirccd-js/irccd/mod-server.cpp Thu Dec 08 13:17:26 2016 +0100 +++ b/libirccd-js/irccd/mod-server.cpp Thu Dec 08 20:06:38 2016 +0100 @@ -1,5 +1,5 @@ /* - * js-server.cpp -- Irccd.Server API + * mod-server.cpp -- Irccd.Server API * * Copyright (c) 2013-2016 David Demelier <markand@malikania.fr> *
--- a/libirccd-js/irccd/mod-system.cpp Thu Dec 08 13:17:26 2016 +0100 +++ b/libirccd-js/irccd/mod-system.cpp Thu Dec 08 20:06:38 2016 +0100 @@ -1,5 +1,5 @@ /* - * js-system.cpp -- Irccd.System API + * mod-system.cpp -- Irccd.System API * * Copyright (c) 2013-2016 David Demelier <markand@malikania.fr> *
--- a/libirccd-js/irccd/mod-timer.cpp Thu Dec 08 13:17:26 2016 +0100 +++ b/libirccd-js/irccd/mod-timer.cpp Thu Dec 08 20:06:38 2016 +0100 @@ -1,5 +1,5 @@ /* - * js-timer.cpp -- Irccd.Timer API + * mod-timer.cpp -- Irccd.Timer API * * Copyright (c) 2013-2016 David Demelier <markand@malikania.fr> *
--- a/libirccd-js/irccd/mod-unicode.cpp Thu Dec 08 13:17:26 2016 +0100 +++ b/libirccd-js/irccd/mod-unicode.cpp Thu Dec 08 20:06:38 2016 +0100 @@ -1,5 +1,5 @@ /* - * js-unicode.cpp -- Irccd.Unicode API + * mod-unicode.cpp -- Irccd.Unicode API * * Copyright (c) 2013-2016 David Demelier <markand@malikania.fr> *
--- a/libirccd-js/irccd/mod-util.cpp Thu Dec 08 13:17:26 2016 +0100 +++ b/libirccd-js/irccd/mod-util.cpp Thu Dec 08 20:06:38 2016 +0100 @@ -1,5 +1,5 @@ /* - * js-util.cpp -- Irccd.Util API + * mod-util.cpp -- Irccd.Util API * * Copyright (c) 2013-2016 David Demelier <markand@malikania.fr> *
--- a/libirccd-js/irccd/timer.hpp Thu Dec 08 13:17:26 2016 +0100 +++ b/libirccd-js/irccd/timer.hpp Thu Dec 08 20:06:38 2016 +0100 @@ -45,7 +45,6 @@ }; /** - * \class Timer * \brief Timer class * * A timer is a thread object that emits a signal periodically or just one time. It is perfectly pausable and resumable
--- a/libirccd-js/irccd/unicode.hpp Thu Dec 08 13:17:26 2016 +0100 +++ b/libirccd-js/irccd/unicode.hpp Thu Dec 08 20:06:38 2016 +0100 @@ -16,8 +16,8 @@ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -#ifndef UNICODE_HPP -#define UNICODE_HPP +#ifndef IRCCD_UNICODE_HPP +#define IRCCD_UNICODE_HPP /** * \file unicode.hpp @@ -270,4 +270,4 @@ } // !irccd -#endif // !UNICODE_HPP +#endif // !IRCCD_UNICODE_HPP
--- a/libirccd/irccd/command.cpp Thu Dec 08 13:17:26 2016 +0100 +++ b/libirccd/irccd/command.cpp Thu Dec 08 20:06:38 2016 +0100 @@ -1,5 +1,5 @@ /* - * cmd-plugin-config.cpp -- implementation of plugin-config command + * command.cpp -- implementation of plugin-config command * * Copyright (c) 2013-2016 David Demelier <markand@malikania.fr> *
--- a/libirccd/irccd/command.hpp Thu Dec 08 13:17:26 2016 +0100 +++ b/libirccd/irccd/command.hpp Thu Dec 08 20:06:38 2016 +0100 @@ -204,15 +204,6 @@ /** * \brief Implementation of server-cnotice transport command. - * - * Send a channel notice to the specified channel. - * - * { - * "command": "server-cnotice", - * "server": "the server name", - * "channel": "name", - * "message": "the message" - * } */ class ServerChannelNoticeCommand : public Command { public: @@ -420,7 +411,6 @@ }; /** - * \class ServerPart * \brief Implementation of server-part transport command. */ class IRCCD_EXPORT ServerPartCommand : public Command { @@ -472,4 +462,4 @@ } // !irccd -#endif // !IRCCD_CMD_SERVER_TOPIC_HPP +#endif // !IRCCD_COMMAND_HPP
--- a/libirccd/irccd/config.hpp Thu Dec 08 13:17:26 2016 +0100 +++ b/libirccd/irccd/config.hpp Thu Dec 08 20:06:38 2016 +0100 @@ -40,7 +40,6 @@ class TransportServer; /** - * \class Config * \brief Read .ini configuration file for irccd */ class Config {
--- a/libirccd/irccd/dynlib.hpp Thu Dec 08 13:17:26 2016 +0100 +++ b/libirccd/irccd/dynlib.hpp Thu Dec 08 20:06:38 2016 +0100 @@ -183,7 +183,6 @@ namespace irccd { /** - * \class Dynlib * \brief Load a dynamic module. * * This class is a portable wrapper to load shared libraries on supported systems.
--- a/libirccd/irccd/irccd.hpp Thu Dec 08 13:17:26 2016 +0100 +++ b/libirccd/irccd/irccd.hpp Thu Dec 08 20:06:38 2016 +0100 @@ -46,7 +46,6 @@ class TransportService; /** - * \class Irccd * \brief Irccd main instance. */ class Irccd {
--- a/libirccd/irccd/rule.hpp Thu Dec 08 13:17:26 2016 +0100 +++ b/libirccd/irccd/rule.hpp Thu Dec 08 20:06:38 2016 +0100 @@ -49,7 +49,6 @@ }; /** - * \class Rule * \brief Manage rule to activate or deactive events. */ class Rule {
--- a/libirccd/irccd/transport.hpp Thu Dec 08 13:17:26 2016 +0100 +++ b/libirccd/irccd/transport.hpp Thu Dec 08 20:06:38 2016 +0100 @@ -39,7 +39,6 @@ class TransportServer; /** - * \class TransportClient * \brief Client connected to irccd. * * This class emits a warning upon clients request through onCommand signal.
--- a/libirccdctl/CMakeLists.txt Thu Dec 08 13:17:26 2016 +0100 +++ b/libirccdctl/CMakeLists.txt Thu Dec 08 20:06:38 2016 +0100 @@ -9,7 +9,6 @@ set( SOURCES ${libirccdctl_SOURCE_DIR}/irccd/client.cpp - ${libirccdctl_SOURCE_DIR}/irccd/irccdctl.cpp ) irccd_define_library(
--- a/libirccdctl/irccd/irccdctl.cpp Thu Dec 08 13:17:26 2016 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,19 +0,0 @@ -/* - * irccdctl.cpp -- main irccdctl class - * - * Copyright (c) 2013-2016 David Demelier <markand@malikania.fr> - * - * Permission to use, copy, modify, and/or distribute this software for any - * purpose with or without fee is hereby granted, provided that the above - * copyright notice and this permission notice appear in all copies. - * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES - * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF - * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR - * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES - * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN - * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF - * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. - */ - -// empty for the moment.
--- a/libirccdctl/irccd/irccdctl.hpp Thu Dec 08 13:17:26 2016 +0100 +++ b/libirccdctl/irccd/irccdctl.hpp Thu Dec 08 20:06:38 2016 +0100 @@ -19,6 +19,11 @@ #ifndef IRCCD_IRCCDCTL_HPP #define IRCCD_IRCCDCTL_HPP +/** + * \file irccdctl.hpp + * \brief Main irccdctl class + */ + #include <memory> #include "client.hpp" @@ -33,26 +38,54 @@ std::unique_ptr<Client> m_client; public: + /** + * Create the irccdctl instance with the specified client. + * + * \param client the client + */ inline Irccdctl(std::unique_ptr<Client> client) noexcept : m_client(std::move(client)) { } + /** + * Get the client. + * + * \return the client reference + */ inline Client &client() noexcept { return *m_client; } + /** + * Overloaded function. + * + * \return the client + */ inline const Client &client() const noexcept { return *m_client; } + /** + * Pollable prepare function. + * + * \param in the input set + * \param out the output set + * \param max the maximum handle + */ inline void prepare(fd_set &in, fd_set &out, net::Handle &max) { m_client->prepare(in, out, max); } + /** + * Pollable sync function. + * + * \param in the input set + * \param out the output set + */ inline void sync(fd_set &in, fd_set &out) { m_client->sync(in, out);