check.docs

Pango is a library for layout and rendering of text, with an emphasis on internationalization. Pang

#!/bin/sh

LANG=C
if test -z "$DOC_MODULE"; then
	# extract from Makefile
	eval `grep '^DOC_MODULE' Makefile | sed 's/ //g'`
	if test -z "$DOC_MODULE"; then
		echo Failed extracting DOC_MODULE from Makefile 1>&2
		echo Try setting DOC_MODULE env var manually 1>&2
		exit 1
	fi
fi


test -z "$srcdir" && srcdir=.
status=0

if ! test -f "$DOC_MODULE-undocumented.txt" -a -f "$DOC_MODULE-unused.txt"; then
	echo At least one of "$DOC_MODULE-undocumented.txt" and "$DOC_MODULE-unused.txt" not found.
	echo Skipping test.
	exit 0
fi

status=0

if test -f "$DOC_MODULE-unused.txt"; then
	unused=`cat "$DOC_MODULE-unused.txt"`
	if test -n "$unused"; then
		echo Unused documentated symbols: 1>&2
		cat "$DOC_MODULE-unused.txt" 1>&2
		status=1
	fi
fi
if test -f "$DOC_MODULE-undocumented.txt"; then
	if ! grep '^0 symbols incomplete' "$DOC_MODULE-undocumented.txt" >/dev/null ||
	   ! grep '^0 not documented'     "$DOC_MODULE-undocumented.txt" >/dev/null; then
		echo Incomplete or undocumented symbols: 1>&2
		cat "$DOC_MODULE-undocumented.txt" 1>&2
		status=1
	fi
fi

exit $status