update documentation.

Author: wengxt

.codedocs

@@ -7,7 +7,7 @@ FILE_PATTERNS          =
 QT_AUTOBRIEF           = YES
 RECURSIVE              = YES
 STRIP_CODE_COMMENTS    = NO
-EXCLUDE_PATTERNS       = "*/src/lib/fcitx-wayland/*" "*/*_p.h
+EXCLUDE_PATTERNS       = "*/src/lib/fcitx-wayland/*" "*/*_p.h"
 ENABLE_PREPROCESSING   = YES
 MACRO_EXPANSION        = YES
 

CMakeLists.txt

@@ -111,6 +111,7 @@ endif ()
 
 if (ENABLE_DOC)
   find_package(Doxygen REQUIRED)
+  file(READ "${CMAKE_CURRENT_SOURCE_DIR}/.codedocs" FCITX_DOXYGEN_CONFIGURATION)
   configure_file(
     ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in
     ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile

Doxyfile.in

@@ -1,18 +1,4 @@
 OUTPUT_DIRECTORY       = @CMAKE_CURRENT_BINARY_DIR@/doc/
-INPUT                  = src/lib
-DOXYFILE_ENCODING      = UTF-8
-PROJECT_NAME           = Fcitx
 PROJECT_NUMBER         = @FCITX_VERSION@
-OUTPUT_LANGUAGE        = English
-SOURCE_BROWSER         = YES
-FILE_PATTERNS          =
-GENERATE_LATEX         = NO
-QT_AUTOBRIEF           = YES
-RECURSIVE              = YES
-STRIP_CODE_COMMENTS    = NO
-EXCLUDE_PATTERNS       = "*/src/lib/fcitx-wayland/*" "*/*_p.h
-ENABLE_PREPROCESSING   = YES
-MACRO_EXPANSION        = YES
 
-STRIP_FROM_PATH        = @CMAKE_CURRENT_SOURCE_DIR@/src/lib
-STRIP_FROM_INC_PATH    = @CMAKE_CURRENT_SOURCE_DIR@/src/lib
+@FCITX_DOXYGEN_CONFIGURATION@

src/lib/fcitx-utils/CMakeLists.txt

@@ -45,6 +45,7 @@ set(FCITX_UTILS_HEADERS
     keysym.h
     keysymgen.h
     signals.h
+    signals_details.h
     handlertable.h
     handlertable_details.h
     intrusivelist.h

src/lib/fcitx-utils/key.h

@@ -20,6 +20,11 @@
 #ifndef _FCITX_UTILS_KEY_H_
 #define _FCITX_UTILS_KEY_H_
 
+/// \addtogroup FcitxUtils
+/// \{
+/// \file
+/// \brief Class to represent a key.
+
 #include "fcitxutils_export.h"
 #include <algorithm>
 #include <cstdint>

src/lib/fcitx-utils/keysym.h

@@ -20,14 +20,17 @@
 #ifndef FCITX_UTILS_KEYSYM_H
 #define FCITX_UTILS_KEYSYM_H
 
+/// \addtogroup FcitxUtils
+/// \{
+/// \file
+/// \brief Key sym related types.
+
 #include <cstdint>
 #include <fcitx-utils/keysymgen.h>
 #include <fcitx-utils/macros.h>
 
 namespace fcitx {
-/**
- * fcitx key state (modifier keys)
- **/
+/// \brief KeyState to represent modifier keys.
 enum class KeyState : uint32_t {
     None = 0,
     Shift = 1 << 0,

src/lib/fcitx-utils/library.h

@@ -19,6 +19,11 @@
 #ifndef _FCITX_UTILS_LIBRARY_H_
 #define _FCITX_UTILS_LIBRARY_H_
 
+/// \addtogroup FcitxUtils
+/// \{
+/// \file
+/// \brief Class to handler dynamic library.
+
 #include "fcitxutils_export.h"
 #include <fcitx-utils/flags.h>
 #include <fcitx-utils/macros.h>

src/lib/fcitx-utils/log.h

@@ -19,6 +19,11 @@
 #ifndef _FCITX_UTILS_LOG_H_
 #define _FCITX_UTILS_LOG_H_
 
+/// \addtogroup FcitxUtils
+/// \{
+/// \file
+/// \brief Log utilities.
+
 #include "fcitxutils_export.h"
 #include <cstdlib>
 #include <fcitx-utils/fs.h>
@@ -29,6 +34,7 @@
 
 namespace fcitx {
 
+/// \brief LogLevel from high to low.
 enum LogLevel : int {
     None = 0,
     Fatal = 1,

src/lib/fcitx-utils/metastring.h

@@ -19,10 +19,16 @@
 #ifndef _FCITX_UTILS_METASTRING_H_
 #define _FCITX_UTILS_METASTRING_H_
 
+/// \addtogroup FcitxUtils
+/// \{
+/// \file
+/// \brief Static string based on template argument.
+
 #include <exception>
 
 namespace fcitx {
 
+
 template <char... c>
 struct MetaString final {
 public:
@@ -135,6 +141,7 @@ struct MetaStringTrim {
         FCITX_METASTRING_TEMPLATE_16(N##E, S),                                 \
         FCITX_METASTRING_TEMPLATE_16(N##F, S)
 
+/// \brief Create meta string from string literal.
 #define fcitxMakeMetaString(STRING)                                            \
     ::fcitx::MetaStringTrim<FCITX_METASTRING_TEMPLATE_256(, STRING)>::type
 }

src/lib/fcitx-utils/rect.h

@@ -19,6 +19,11 @@
 #ifndef _FCITX_UTILS_RECT_H_
 #define _FCITX_UTILS_RECT_H_
 
+/// \addtogroup FcitxUtils
+/// \{
+/// \file
+/// \brief Provide utility to handle rectangle.
+
 #include "fcitxutils_export.h"
 
 namespace fcitx {

src/lib/fcitx-utils/signals.h

@@ -19,15 +19,22 @@
 #ifndef _FCITX_UTILS_SIGNALS_H_
 #define _FCITX_UTILS_SIGNALS_H_
 
+/// \addtogroup FcitxUtils
+/// \{
+/// \file
+/// \brief A signal-slot implemention.
+
 #include <fcitx-utils/handlertable.h>
 #include <fcitx-utils/intrusivelist.h>
 #include <fcitx-utils/macros.h>
 #include <fcitx-utils/trackableobject.h>
 #include <fcitx-utils/tuplehelpers.h>
+#include <fcitx-utils/signals_details.h>
 #include <tuple>
 
 namespace fcitx {
 
+/// \brief Combiner that return the last value.
 template <typename T>
 class LastValue {
 public:
@@ -45,6 +52,7 @@ class LastValue {
 private:
     T initial_;
 };
+
 template <>
 class LastValue<void> {
 public:
@@ -57,90 +65,8 @@ class LastValue<void> {
     }
 };
 
-template <typename Ret, typename... Args>
-class Invoker {
-public:
-    Invoker(Args &... args) : args_(args...) {}
-
-    template <typename Func>
-    Ret operator()(Func &func) {
-        return callWithTuple(func, args_);
-    }
-
-private:
-    std::tuple<Args &...> args_;
-};
-
-template <typename T>
-class SlotInvokeIterator;
-
-template <typename Ret, typename... Args>
-class SlotInvokeIterator<std::function<Ret(Args...)>> {
-public:
-    typedef std::input_iterator_tag iterator_category;
-    typedef std::function<Ret(Args...)> function_type;
-    typedef typename function_type::result_type value_type;
-    typedef std::ptrdiff_t difference_type;
-    typedef value_type reference;
-    typedef typename HandlerTableView<function_type>::iterator super_iterator;
-    typedef SlotInvokeIterator iterator;
-    typedef Invoker<Ret, Args...> invoker_type;
-
-    SlotInvokeIterator(invoker_type &invoker, super_iterator iter)
-        : parentIter_(iter), invoker_(invoker) {}
-
-    SlotInvokeIterator(const iterator &other) = default;
-
-    iterator &operator=(const iterator &other) = default;
-
-    bool operator==(const iterator &other) const noexcept {
-        return parentIter_ == other.parentIter_;
-    }
-    bool operator!=(const iterator &other) const noexcept {
-        return !operator==(other);
-    }
-
-    iterator &operator++() {
-        parentIter_++;
-        return *this;
-    }
-
-    iterator operator++(int) {
-        auto old = parentIter_;
-        ++(*this);
-        return {invoker_, old};
-    }
-
-    reference operator*() { return invoker_(*parentIter_); }
-
-private:
-    super_iterator parentIter_;
-    invoker_type &invoker_;
-};
-
-template <typename Invoker, typename Iter>
-SlotInvokeIterator<typename Iter::value_type>
-MakeSlotInvokeIterator(Invoker invoker, Iter iter) {
-    return {invoker, iter};
-}
-
-template <typename T,
-          typename Combiner = LastValue<typename std::function<T>::result_type>>
-class Signal;
-
-class ConnectionBody : public TrackableObject<ConnectionBody>,
-                       public IntrusiveListNode {
-public:
-    template <typename T>
-    ConnectionBody(HandlerTableEntry<T> *entry) : entry_(entry) {}
-
-    virtual ~ConnectionBody() { remove(); }
-
-private:
-    // Need type erasure here
-    std::shared_ptr<void> entry_;
-};
-
+/// \brief A connection instance. Can be used to query the existence of
+/// connection.
 class Connection {
 public:
     Connection() {}
@@ -165,6 +91,8 @@ class Connection {
     TrackableObjectReference<ConnectionBody> body_;
 };
 
+/// \brief Connection that will disconnection when it goes out of scope.
+/// \see Connection
 class ScopedConnection : public Connection {
 public:
     // You must create two Connection if you really want two ScopedConnection
@@ -194,9 +122,14 @@ class ScopedConnection : public Connection {
 
 class SignalBase {
 public:
-    virtual ~SignalBase() {}
+    virtual ~SignalBase() = default;
 };
 
+/// \brief Class to represent a signal. May be used like a functor.
+template <typename T,
+          typename Combiner = LastValue<typename std::function<T>::result_type>>
+class Signal;
+
 template <typename Ret, typename Combiner, typename... Args>
 class Signal<Ret(Args...), Combiner> : public SignalBase {
     struct SignalData {
@@ -217,7 +150,7 @@ class Signal<Ret(Args...), Combiner> : public SignalBase {
             disconnectAll();
         }
     }
-    Signal(Signal &&other) noexcept { operator=(std::forward<Signal>(other)); }
+    Signal(Signal &&other) noexcept { operator=(std::move<Signal>(other)); }
     Signal &operator=(Signal &&other) noexcept {
         using std::swap;
         swap(d_ptr, other.d_ptr);