| 1 | '''C function documentation''' |
| 2 | |
| 3 | The test t/codingstd/c_function_docs.t checks for documentation relating to C functions. |
| 4 | |
| 5 | It performs two functions: |
| 6 | |
| 7 | 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). |
| 8 | |
| 9 | 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). |
| 10 | |
| 11 | As of r43470 I have compiled a report on the current functions missing [wiki:MissingCFunctionDocs] documentation and of those lacking (boilerplate only) [wiki:BoilerplateOnlyDocs] documentation. |
| 12 | |
| 13 | Bear in mind we are dealing with POD and that it expects a maximum line length of 78. |
| 14 | |
| 15 | 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. |
| 16 | {{{ |
| 17 | |
| 18 | __DATA__ |
| 19 | compilers/imcc/instructions.c |
| 20 | compilers/imcc/optimizer.c |
| 21 | compilers/imcc/parser_util.c |
| 22 | compilers/imcc/pbc.c |
| 23 | compilers/imcc/pcc.c |
| 24 | compilers/imcc/reg_alloc.c |
| 25 | compilers/imcc/symreg.c |
| 26 | compilers/pirc/src/pircapi.c |
| 27 | compilers/pirc/src/pircompiler.c |
| 28 | compilers/pirc/src/piremit.c |
| 29 | compilers/pirc/src/pirmacro.c |
| 30 | compilers/pirc/src/pirpcc.c |
| 31 | compilers/pirc/src/pirregalloc.c |
| 32 | compilers/pirc/src/pirsymbol.c |
| 33 | config/gen/platform/ansi/dl.c |
| 34 | config/gen/platform/ansi/exec.c |
| 35 | config/gen/platform/ansi/time.c |
| 36 | config/gen/platform/darwin/dl.c |
| 37 | config/gen/platform/darwin/memalign.c |
| 38 | config/gen/platform/generic/dl.c |
| 39 | config/gen/platform/generic/env.c |
| 40 | config/gen/platform/generic/exec.c |
| 41 | config/gen/platform/generic/math.c |
| 42 | config/gen/platform/generic/memalign.c |
| 43 | config/gen/platform/generic/memexec.c |
| 44 | config/gen/platform/generic/stat.c |
| 45 | config/gen/platform/generic/time.c |
| 46 | config/gen/platform/netbsd/math.c |
| 47 | config/gen/platform/openbsd/math.c |
| 48 | config/gen/platform/openbsd/memexec.c |
| 49 | config/gen/platform/solaris/math.c |
| 50 | config/gen/platform/solaris/time.c |
| 51 | examples/c/nanoparrot.c |
| 52 | examples/c/pbc_info.c |
| 53 | examples/compilers/japhc.c |
| 54 | src/atomic/gcc_x86.c |
| 55 | src/debug.c |
| 56 | src/gc/generational_ms.c |
| 57 | src/io/io_string.c |
| 58 | src/nci_test.c |
| 59 | src/pbc_dump.c |
| 60 | src/string/charset/ascii.c |
| 61 | src/string/charset/binary.c |
| 62 | src/string/charset/iso-8859-1.c |
| 63 | src/string/charset/unicode.c |
| 64 | src/tsq.c |
| 65 | include/parrot/atomic/gcc_pcc.h |
| 66 | |
| 67 | }}} |
| 68 | |
| 69 | as at r43470 |