init doxygen

documentation/CMakeLists.txt

@@ -0,0 +1,37 @@
+cmake_minimum_required(VERSION 3.5 FATAL_ERROR)
+
+project(GreeterDocumentation
+  LANGUAGES CXX
+)
+
+# --- Import tools ----
+
+include(../cmake/tools.cmake)
+
+# ---- Dependencies ----
+
+include(../cmake/CPM.cmake)
+
+CPMAddPackage(
+  NAME Greeter
+  SOURCE_DIR ${CMAKE_CURRENT_LIST_DIR}/..
+)
+
+CPMAddPackage(
+  NAME StableCoder-cmake-scripts
+  GITHUB_REPOSITORY StableCoder/cmake-scripts
+  GIT_TAG 3d2d5a9fb26f0ce24e3e4eaeeff686ec2ecfb3fb
+)
+
+# ---- Doxygen ----
+
+set(BUILD_DOCUMENTATION ON CACHE INTERNAL "")
+include(${StableCoder-cmake-scripts_SOURCE_DIR}/doxygen.cmake)
+
+# see https://github.com/StableCoder/cmake-scripts#doxygen-doxygencmake for options
+build_docs(
+  TARGET_NAME GenerateDocs
+  DOXYFILE_PATH ${CMAKE_CURRENT_LIST_DIR}/Doxyfile
+  OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/doc
+  PROCESS_DOXYFILE ON
+)

include/greeter.h

@@ -4,13 +4,28 @@
 
 namespace greeter {
 
+  /**  Language codes to be used with the Greeter class */
   enum class LanguageCode { EN, DE, ES, FR };
 
+  /**
+   * A class for greeting in multiple languages
+   */
   class Greeter {
     std::string name;
 
   public:
+
+    /**
+     * Creates a new greeter
+     * @param name the name to greet 
+     */
     Greeter(std::string name);
+
+    /**
+     * Creates a localized string containing the greeting 
+     * @param lang the language to greet in
+     * @return a string containing the greeting
+     */
     std::string greet(LanguageCode lang = LanguageCode::EN) const;
   };