mirror of
https://github.com/EttusResearch/uhd.git
synced 2026-10-25 17:36:10 +00:00
This adds a basic check for the correct format of Doxygen comments. Since there were comments that started with `//!` and continued in the next line with `//`, but Doxygen only used the first line, this ensures that there aren't any such comments anymore. Refer to the coding guidelines to see the correct format for documentation in the code.
28 lines
837 B
YAML
28 lines
837 B
YAML
repos:
|
|
- repo: git@github.com:ssciwr/clang-format-hook.git
|
|
rev: 'v14.0.6'
|
|
hooks:
|
|
- id: clang-format
|
|
- repo: local
|
|
hooks:
|
|
- id: ni-python-styleguide-fix
|
|
name: ni-python-styleguide-fix
|
|
description: Run NI Python Style Checker (Fixer)
|
|
language: python
|
|
types_or: [python]
|
|
entry: ni-python-styleguide fix
|
|
- id: ni-python-styleguide-lint
|
|
name: ni-python-styleguide-lint
|
|
description: Run NI Python Style Checker (Linter)
|
|
language: python
|
|
types_or: [python]
|
|
entry: ni-python-styleguide lint
|
|
# TODO: re-enable linting until we have the fixed all files at once
|
|
exclude: ^mpm
|
|
- id: check-doxygen-format
|
|
name: check_doxygen_format
|
|
description: Check for broken Doxygen comments in C++ files
|
|
language: python
|
|
types: [c++]
|
|
entry: python tools/check_doxygen_format.py
|