fix doxygen warnings and tags #53
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # | |
| # .github/workflows/cpp-quality.yml | |
| # | |
| # SPDX-License-Identifier: MIT | |
| # SPDX-FileCopyrightText: 2024 Jens A. Koch. | |
| # This file is part of fifengine/fifechan. | |
| # | |
| name: "C++ Quality" | |
| on: | |
| - push | |
| - pull_request | |
| # You can manually run this workflow. | |
| - workflow_dispatch | |
| # improve CI concurrency by automatically cancelling outdated jobs | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.head_ref || github.ref }} | |
| cancel-in-progress: true | |
| permissions: | |
| contents: read | |
| jobs: | |
| # --------------------------------------------------------------------------------------- | |
| clang-format: | |
| # --------------------------------------------------------------------------------------- | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: 🤘 Checkout Code | |
| uses: actions/checkout@v4 # https://github.com/actions/checkout | |
| - name: 🔽 Install dos2unix | |
| run: sudo apt-get install -y dos2unix | |
| - name: 🔽 Install clang-format-18 | |
| run: | | |
| wget https://apt.llvm.org/llvm.sh | |
| chmod +x ./llvm.sh | |
| sudo ./llvm.sh 18 | |
| sudo apt-get install -y clang-format-18 | |
| rm llvm.sh | |
| - name: 🛠️ Check Formatting | |
| continue-on-error: true | |
| run: | | |
| ./build-tools/format.sh | |
| env: | |
| CLANG_FORMAT: clang-format-18 | |
| - name: 🛠️ Check git | |
| run: | | |
| git status | |
| git diff | |
| # --------------------------------------------------------------------------------------- | |
| cpplint: | |
| # --------------------------------------------------------------------------------------- | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: 🤘 Checkout Code | |
| uses: actions/checkout@v4 # https://github.com/actions/checkout | |
| - name: 🔽 Setup Python | |
| run: sudo apt-get -y install python3 python3-pip python3-venv | |
| - name: 🔽 Setup Python Virtual Env | |
| run: | | |
| export VIRTUAL_ENV=/opt/venv | |
| python3 -m venv $VIRTUAL_ENV | |
| export PATH="$VIRTUAL_ENV/bin:$PATH" | |
| - name: 🔽 Install cpplint | |
| run: | | |
| pip install --prefer-binary --no-cache-dir cpplint | |
| - name: 🛠️ Run cpplint | |
| run: | | |
| cpplint --recursive src include tests examples | |
| - name: 🛠️ Identify places where 'reinterpret_cast' is used | |
| run: | | |
| grep -rniw --include=\*.{cpp,hpp} "reinterpret_cast" src include tests examples |