Added doxygen support
This commit is contained in:
parent
f8c48b05a0
commit
1dfd8ec504
@ -4,6 +4,7 @@
|
|||||||
- zsh
|
- zsh
|
||||||
- astyle 2.04+
|
- astyle 2.04+
|
||||||
- perl
|
- perl
|
||||||
|
- doxygen (optional, for checking if all code is documented)
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
```sh
|
```sh
|
||||||
|
@ -25,3 +25,15 @@ if which colout>/dev/null; then
|
|||||||
else
|
else
|
||||||
astyle $OPTS $GLOB|\grep -P '^(?!Unchanged)'||true
|
astyle $OPTS $GLOB|\grep -P '^(?!Unchanged)'||true
|
||||||
fi
|
fi
|
||||||
|
# Now check for documentation
|
||||||
|
# Run doxygen, redirecting stdout to dev null, and setting stderr to $OUTPUT
|
||||||
|
if command -v doxygen >/dev/null; then
|
||||||
|
OUTPUT=$((doxygen "${0:h}/Doxyfile" > /dev/null) 2>&1)
|
||||||
|
# If there is output, something went wrong
|
||||||
|
if [ ! -z "$OUTPUT" ]; then
|
||||||
|
printf "$OUTPUT\n" >&2
|
||||||
|
return 2
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
printf "You don't have doxygen installed. Can't check documentation\n" >&2
|
||||||
|
fi
|
||||||
|
Loading…
Reference in New Issue
Block a user