Changes between Initial Version and Version 1 of CFunctionDocs

Show
Ignore:
Timestamp:
01/16/10 15:31:57 (12 years ago)
Author:
mikehh
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • CFunctionDocs

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