fdo-mirrors/cairo
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/cairo/cairo.git synced 2026-05-05 05:18:01 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

[doc/public/check-doc-coverage.sh] Test that doc coverage is 100%

Browse source 
Yay!
This commit is contained in:
Behdad Esfahbod 2008-01-28 21:02:44 -05:00
parent c133ee5acc
commit fd5dfedbb7
2 changed files with 45 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/public/Makefile.am
View file

@ -70,3 +70,5 @@ include $(top_srcdir)/gtk-doc.make
# Version information for marking the documentation
EXTRA_DIST += version.xml.in
TESTS_ENVIRONMENT = srcdir="$(srcdir)" MAKE="$(MAKE)"
TESTS = check-doc-coverage.sh

43
doc/public/check-doc-coverage.sh Executable file
View file

@ -0,0 +1,43 @@
#!/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