Added Doxygen support.

Closes #24. Closes #26.
xvitaly · Apr 26, 2020 · 90e64db · 90e64db
1 parent 94f3d51
commit 90e64db
Show file tree

Hide file tree

Showing 9 changed files with 489 additions and 4 deletions.
diff --git a/.gitignore b/.gitignore
@@ -30,3 +30,8 @@
 *.exe
 *.out
 *.app
+
+# Doxygen output
+/Doxyfile
+/doxyout
+
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,10 +1,11 @@
 cmake_minimum_required(VERSION 3.10)
 
-project(zswap-cli LANGUAGES CXX)
+project(zswap-cli VERSION 0.4.0 LANGUAGES CXX)
 
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
+include(cmake/Settings.cmake)
 include(cmake/External.cmake)
 
 include_directories("src/app")

diff --git a/cmake/Settings.cmake b/cmake/Settings.cmake
@@ -0,0 +1 @@
+option(BUILD_DOC "Build documentation" OFF)
diff --git a/docs/doxygen.md b/docs/doxygen.md
@@ -0,0 +1,11 @@
+# Documentation
+
+## About
+
+ZSwap-cli is a command-line tool to control [zswap](https://github.com/torvalds/linux/blob/master/Documentation/vm/zswap.rst) Linux kernel module options.
+
+## Pages
+
+  * [Installation](docs/installation.md).
+  * [Using application](docs/using-application.md).
+  * [Environment options](docs/environment-options.md).