Files
nRF52840_PTT/Doxyfile
Krzysztof Cieślik 39a89036cc
Some checks failed
CI / Build firmware (push) Failing after 2m1s
CI / Check formatting (push) Successful in 5s
CI / Static analysis (push) Failing after 5s
CI / Build documentation (push) Successful in 4s
Add Doxygen, clang-format, cppcheck, and Gitea CI
Doxygen:
- Doxyfile: minimal config, HTML output to docs/, no LaTeX
- @file/@brief on all source files, full @param/@return on public API
- docs/ added to .gitignore

clang-format (14, Linux brace style, 4-space, column 100):
- .clang-format added
- Applied to entire codebase; this commit is the canonical baseline
- just format rewrites in-place; just format-check is the CI gate

cppcheck (--enable=warning,style,performance,portability):
- Linker-symbol pointer comparisons in startup.c suppressed with
  inline cppcheck-suppress (false positives, not real bugs)
- just lint runs cppcheck; zero warnings required to pass

Dockerfile gains clang-format, cppcheck, doxygen packages so all
tools run inside the existing container -- host stays clean.

Gitea Actions (.gitea/workflows/ci.yml):
- Four parallel jobs: build, format, lint, docs
- All jobs use the same Dockerfile-based image
- Doxygen job fails on any warning line in output
2026-05-21 23:07:05 +02:00

22 lines
677 B
Plaintext

PROJECT_NAME = "ptt-fhss"
PROJECT_BRIEF = "Bare-metal PTT firmware for nRF52840 with FHSS"
PROJECT_NUMBER =
OUTPUT_DIRECTORY = docs
INPUT = include src
FILE_PATTERNS = *.h *.c
RECURSIVE = NO
EXTRACT_ALL = YES
EXTRACT_STATIC = YES
QUIET = YES
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_NO_PARAMDOC = YES
GENERATE_HTML = YES
HTML_OUTPUT = html
HTML_TIMESTAMP = NO
GENERATE_LATEX = NO
HAVE_DOT = NO
OPTIMIZE_OUTPUT_FOR_C = YES
JAVADOC_AUTOBRIEF = YES
PREDEFINED = NRF52840_XXAA