diff options
| author | Simon Rettberg | 2025-07-29 14:38:08 +0200 |
|---|---|---|
| committer | Simon Rettberg | 2025-07-29 14:38:08 +0200 |
| commit | 126738b257637cce7e1aaaee721bd1808312bd52 (patch) | |
| tree | 943285b96a3e2da1ad31cb7aefe6427fd6c953e3 | |
| parent | iSCSI Hash map now resizes at 75% load capacity. Added basic text key and val... (diff) | |
| download | dnbd3-126738b257637cce7e1aaaee721bd1808312bd52.tar.gz dnbd3-126738b257637cce7e1aaaee721bd1808312bd52.tar.xz dnbd3-126738b257637cce7e1aaaee721bd1808312bd52.zip | |
doxygen: Add initial config and gitlab runner job
| -rw-r--r-- | .gitlab-ci.yml | 27 | ||||
| -rw-r--r-- | Doxyfile | 54 |
2 files changed, 81 insertions, 0 deletions
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..3d12eba --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,27 @@ +default: + image: debian:trixie-slim + +variables: + GIT_SUBMODULE_STRATEGY: recursive + +build: + stage: build + script: + - apt-get update + - apt-get install -y git doxygen gcc cmake make libjansson-dev libfuse-dev + - doxygen + artifacts: + paths: + - docs + +pages: + stage: deploy +# only: +# variables: +# - $CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH + script: + - rm -rf -- public + - mv -- docs public + artifacts: + paths: + - public diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 0000000..aa35fd5 --- /dev/null +++ b/Doxyfile @@ -0,0 +1,54 @@ +# Doxyfile for dnbd3 project + +# Project Info +PROJECT_NAME = dnbd3 +PROJECT_BRIEF = "Documentation for dnbd3 C project" +OUTPUT_DIRECTORY = docs +CREATE_SUBDIRS = NO + +# HTML output +GENERATE_HTML = YES +HTML_OUTPUT = html +HTML_FILE_EXTENSION = .html +HTML_COLORSTYLE_HUE = 220 + +# Input +INPUT = src README.md +RECURSIVE = YES +FILE_PATTERNS = *.c *.h CMakeLists.txt *.md + +# Exclude unnecessary stuff (e.g., markdown or docs if not needed) +#EXCLUDE_PATTERNS = */cowDoc/* *.md + +# Source browsing +SOURCE_BROWSER = YES +INLINE_SOURCES = YES +STRIP_CODE_COMMENTS = NO + +# Preprocessor +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = YES +EXPAND_ONLY_PREDEF = NO +SKIP_FUNCTION_MACROS = YES + +# Warnings +WARN_IF_UNDOCUMENTED = YES +WARN_NO_PARAMDOC = YES + +# Dot (call graphs etc.) +HAVE_DOT = YES +CALL_GRAPH = YES +CALLER_GRAPH = YES +DOT_MULTI_TARGETS = YES + +# Other output (disabled) +GENERATE_LATEX = NO +GENERATE_MAN = NO +GENERATE_RTF = NO +GENERATE_XML = NO + +# Misc +EXTRACT_ALL = YES +EXTRACT_PRIVATE = NO +EXTRACT_STATIC = YES +QUIET = NO |