Changes between Version 6 and Version 7 of CFunctionDocs

Show
Ignore:
Timestamp:
06/30/10 00:47:43 (4 years ago)
Author:
mikehh
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • CFunctionDocs

    v6 v7  
    99Secondly, 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). 
    1010 
    11 As of r43470 (now at r44170) I have compiled a report on the current functions missing [wiki:MissingCFunctionDocs] documentation and of those lacking (boilerplate only) [wiki:BoilerplateOnlyDocs] documentation. 
    1211 
    13 Bear in mind we are dealing with POD and that it expects a maximum line length of 78. 
     12As at r47918 there are now no remaining functions in the repository that do not have the required documentation. 
     13 
     14Previously I had compiled a report on the current functions missing [wiki:MissingCFunctionDocs] documentation and of those lacking (boilerplate only) [wiki:BoilerplateOnlyDocs] documentation. 
     15 
     16For the moment these links will remain as they will document how to correct the documentation if the test fails at any stage in the future. 
     17 
     18 
     19Bear in mind we are dealing with POD and that it expects a maximum line length of 80. 
     20 
    1421 
    1522If 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. 
     
    1724 
    1825__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 config/gen/platform/ansi/dl.c 
    28 config/gen/platform/ansi/exec.c 
    29 config/gen/platform/ansi/time.c 
    30 config/gen/platform/darwin/dl.c 
    31 config/gen/platform/darwin/memalign.c 
    32 config/gen/platform/generic/dl.c 
    33 config/gen/platform/generic/exec.c 
    34 config/gen/platform/generic/math.c 
    35 config/gen/platform/generic/memalign.c 
    36 config/gen/platform/generic/stat.c 
    37 config/gen/platform/generic/time.c 
    38 config/gen/platform/netbsd/math.c 
    39 config/gen/platform/openbsd/math.c 
    40 config/gen/platform/solaris/math.c 
    41 config/gen/platform/solaris/time.c 
    42 examples/compilers/japhc.c 
    43 src/gc/generational_ms.c 
    44 src/io/io_string.c 
    45 src/string/charset/ascii.c 
    46 src/string/charset/binary.c 
    47 src/string/charset/iso-8859-1.c 
    48 src/string/charset/unicode.c 
    49 src/tsq.c 
    5026 
    5127}}} 
    5228 
    53 as at r44170 
     29this list is now empty as at r47918 and hopefully will remain so.