LibreWands/Tools/documentation-checker.sh

22 lines
916 B
Bash
Executable File

#/bin/bash
# This file is part of LibreWands.
# LibreWands is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
# LibreWands is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
# You should have received a copy of the GNU General Public License along with LibreWands. If not, see https://www.gnu.org/licenses/.
# ---
# Calculates words in documentation per line of code.
#
SRC=$(cat ./Source/* | wc -l)
DOC=$(cat ./Documentation/Articles/* | wc -w)
PER=$(echo "($DOC / $SRC)" | bc -l)
echo "$DOC words in documentation per $SRC lines of code. ($PER)"