diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..e04fb32 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,35 @@ +name: DOCS + +on: + pull_request: + branches: + - '*' + workflow_dispatch: + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + with: + submodules: recursive # ✅ ensure Catch2 is pulled in + + - name: Install gcc14 + run: | + sudo apt update + sudo apt install -y gcc-14 g++-14 + shell: bash + + - name: Install Doxygen + run: | + sudo apt update + sudo apt install -y doxygen + + - name: Build and Test Project + run: | + cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DMSTD_BUILD_DOCS=ON + make docs # at the moment only building docs to verify no doc-related build issues + env: + CC: gcc-14 + CXX: g++-14 \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index e0eac9f..39e359c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -18,6 +18,7 @@ All notable changes to this project will be documented in this file. - Add Compile flag `MSTD_IGNORE_BUGGY_CODE` to ignore any kind of warnings for buggy libraries or headers - Add exhaustive error flags for compilation +- Add checking of doxygen comments via building docs (no docs is building for gh pages - yet) ## [0.0.2](https://github.com/97gamjak/mstd/releases/tag/0.0.2) - 2025-11-20 diff --git a/docs/Doxyfile b/docs/Doxyfile index 88ee01b..51633db 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -65,7 +65,8 @@ WARNINGS = YES WARN_IF_UNDOCUMENTED = YES WARN_IF_DOC_ERROR = YES WARN_IF_INCOMPLETE_DOC = YES -WARN_NO_PARAMDOC = NO +WARN_NO_PARAMDOC = YES +WARN_AS_ERROR = YES WARN_FORMAT = "$file:$line: $text" #--------------------------------------------------------------------------- diff --git a/include/mstd/quantity/quantity.hpp b/include/mstd/quantity/quantity.hpp index 18d0a99..c7ed4cb 100644 --- a/include/mstd/quantity/quantity.hpp +++ b/include/mstd/quantity/quantity.hpp @@ -71,7 +71,6 @@ namespace mstd /** * @brief Construct a Quantity from a base value (SI unit). * - * @param from_base_tag Tag to indicate base value construction. * @param base The base value in SI units. */ constexpr Quantity(from_base_t, Rep base) // base (SI) ctor