Add docs build

Author: bgao-onet

CMakeLists.txt

@@ -23,6 +23,7 @@ option(CPPBASE_BUILD_RAPIDJSON "Build RapidJson"   ${CPPBASE_STANDALONE_PROJECT}
 option(CPPBASE_BUILD_RAPIDXML  "Build RapidXml"    ${CPPBASE_STANDALONE_PROJECT})
 option(CPPBASE_BUILD_SIGSLOT   "Build sigslot"     ${CPPBASE_STANDALONE_PROJECT})
 option(CPPBASE_BUILD_YAML_CPP  "Build YAML-CPP"    OFF)
+option(CPPBASE_BUILD_DOCS      "Build document"    ${CPPBASE_STANDALONE_PROJECT})
 option(CPPBASE_USE_RTTR        "Use RTTR library (default=ON)" ON)
 
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
@@ -70,6 +71,10 @@ if(CPPBASE_BUILD_TESTING)
   add_subdirectory(tests)
 endif()
 
+if(CPPBASE_BUILD_DOCS)
+  add_subdirectory(docs)
+endif()
+
 include(ClangFormat)
 clang_format_recurse("common" "logging" "network" "tests")
 

LICENSE

@@ -1,10 +1,12 @@
-Copyright 2022 O-Net Communications (USA) Inc.
+Apache License (Apache-2.0)
+
+Copyright (c) 2022 O-Net Communications (USA) Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
 
-    http://www.apache.org/licenses/LICENSE-2.0
+    https://www.apache.org/licenses/LICENSE-2.0.txt
 
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,

README.md

@@ -1,4 +1,7 @@
 ![workflow](https://github.com/o-netusa/cppbase/actions/workflows/build.yml/badge.svg)
+![Language: C++17](https://img.shields.io/badge/Language-C%2B%2B17-yellow)
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Open in Visual Studio Code](https://img.shields.io/badge/-Open%20in%20Visual%20Studio%20Code-007acc)](https://vscode.dev/github/o-netusa/cppbase)
 
 # cppbase
 C++17 cross-platform header-only library providing common features for C++ projects, such as variant, logging, serialization, task sequence, thread pool, TCP/UDP client and server, etc.
@@ -12,6 +15,8 @@ C++17 cross-platform header-only library providing common features for C++ proje
 **Serialization** internally uses [cereal](https://github.com/USCiLab/cereal) to serialize and deserialize data. [Serializer](common/Serializer.h) provides a set of convenient functions to serialize and deserialize objects to/from a string or a file in binary format, which can be easily changed to JSON or XML.
 ### Sequence
 **Sequence** is a set of classes ([Processor](sequence/Processor.h), [Sequence](sequence/Sequence.h), [Link](sequence/Link.h)) that allows user to execute a series of processing unit. It internally uses [taskflow](https://github.com/taskflow/taskflow) as the execution engine. Together with **Variant**, it provides an easy way to create a sequence that contains multiple processors with different functionalities to finish complex tasks. Refer to [tests/common/SequenceTests.cpp](tests/sequence/SequenceTests.cpp) and [tests/sequence/ProcessorTests.cpp] for examples.
+
+![Processor, Sequence and link](docs/images/sequence_processor.png)
 ### Thread Pool
 There are two threadpools in this library: **ThreadPool** and **ForkJoinPool**. The former is based on https://github.com/progschj/ThreadPool.git and the latter is based on [asio's fork join pool](https://raw.githubusercontent.com/boostorg/asio/develop/example/cpp14/executors/fork_join.cpp).
 ### TCP/UDP Client and Server

common/Serializer.h

@@ -79,7 +79,7 @@ class Serializer
     /**
      * @brief Deserialize an object from a string
      *
-     * @param str String representation of the object
+     * @param archive String representation of the object
      * @return The loaded object
      */
     template <typename InArchive, typename T>
@@ -88,27 +88,53 @@ class Serializer
         std::stringstream ss;
         ss << archive;
         InArchive arch(ss);
-        // std::shared_ptr<T> obj;
         T obj;
         arch(obj);
         return obj;
     }
 
+    /**
+     * @brief Serialize an object to a binary archive file
+     *
+     * @param obj Object to be serialized
+     * @param archive_path Path to the archive file to be created
+     */
     template<typename T>
     static void SaveObjectToFileBinary(const T& obj, const std::string& archive_path)
     {
         SaveObjectToFile<BinaryOutputArchive, T>(obj, archive_path);
     }
+
+    /**
+     * @brief Serialize an object to a binary archive string
+     *
+     * @param obj Object to be serialized
+     * @return std::string String that contains the archive data
+     */
     template<typename T>
     static std::string SaveObjectToStringBinary(const T& obj)
     {
         return SaveObjectToString<BinaryOutputArchive, T>(obj);
     }
+
+    /**
+     * @brief Deserialize an object from a binary archive file
+     *
+     * @param archive_path Path to the archive file to be loaded
+     * @return The loaded object
+     */
     template<typename T>
     static T LoadObjectFromFileBinary(const std::string& archive_path)
     {
         return LoadObjectFromFile<BinaryInputArchive, T>(archive_path);
     }
+
+    /**
+     * @brief Deserialize an object from a binary archive string
+     *
+     * @param archive String that contains the archive data
+     * @return The loaded object
+     */
     template<typename T>
     static T LoadObjectFromStringBinary(const std::string& archive)
     {

docs/CMakeLists.txt

@@ -0,0 +1,20 @@
+find_package(Doxygen)
+
+if(NOT DOXYGEN_FOUND)
+    message(STATUS "No Doxygen found. Documentation won't be built")
+else()
+    set(OUT_DOXYFILE ${CMAKE_BINARY_DIR}/Doxyfile)
+
+    configure_file(Doxyfile.in ${OUT_DOXYFILE} @ONLY)
+
+    add_custom_target(docs ALL
+        COMMAND ${DOXYGEN_EXECUTABLE} ${OUT_DOXYFILE}
+        WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+        COMMENT "Generating API documentation with doxygen"
+        VERBATIM
+    )
+
+    install(DIRECTORY ${CMAKE_BINARY_DIR}/docs/html
+        DESTINATION docs
+    )
+endif()