Version 5 (modified by mikehh, 12 years ago) |
---|
C function documentation
The test t/codingstd/c_function_docs.t checks for documentation relating to C functions.
It performs two functions:
Firstly it scans the C source for functions in parrot and checks that each function has documentation associated with it and reports it missing if it does not find the corresponding documentation. It reports - (missing).
Secondly, it checks that there is content in the documentation, if it does not find content, i.e. only the header (=item C<...>) exists. It reports - (boilerplate only).
As of r43470 (now at r44163) I have compiled a report on the current functions missing MissingCFunctionDocs documentation and of those lacking (boilerplate only) BoilerplateOnlyDocs documentation.
Bear in mind we are dealing with POD and that it expects a maximum line length of 78.
If the documentation is corrected (patched) the test t/codingstd/c_function_docs.t has a TODO list for the failures (in the DATA section at the end) and if corrected the corresponding entry needs to be removed from the test.
__DATA__ compilers/imcc/instructions.c compilers/imcc/optimizer.c compilers/imcc/parser_util.c compilers/imcc/pbc.c compilers/imcc/pcc.c compilers/imcc/reg_alloc.c compilers/imcc/symreg.c compilers/pirc/src/pircapi.c config/gen/platform/ansi/dl.c config/gen/platform/ansi/exec.c config/gen/platform/ansi/time.c config/gen/platform/darwin/dl.c config/gen/platform/darwin/memalign.c config/gen/platform/generic/dl.c config/gen/platform/generic/env.c config/gen/platform/generic/exec.c config/gen/platform/generic/math.c config/gen/platform/generic/memalign.c config/gen/platform/generic/memexec.c config/gen/platform/generic/stat.c config/gen/platform/generic/time.c config/gen/platform/netbsd/math.c config/gen/platform/openbsd/math.c config/gen/platform/openbsd/memexec.c config/gen/platform/solaris/math.c config/gen/platform/solaris/time.c examples/c/pbc_info.c examples/compilers/japhc.c src/atomic/gcc_x86.c src/debug.c src/gc/generational_ms.c src/io/io_string.c src/string/charset/ascii.c src/string/charset/binary.c src/string/charset/iso-8859-1.c src/string/charset/unicode.c src/tsq.c include/parrot/atomic/gcc_pcc.h
as at r44163